'1.0', 'info' => ['style' => 'RPC', 'product' => 'R-kvstore', 'version' => '2015-01-01'], 'directories' => [ [ 'children' => ['CreateInstance', 'CreateGlobalDistributeCache', 'DeleteShardingNode', 'DestroyInstance', 'TransformToPrePaid'], 'type' => 'directory', 'title' => 'Lifecycle management', ], [ 'children' => ['CreateTairInstance', 'CreateInstances', 'EnableAdditionalBandwidth', 'DescribeInstances', 'DescribeInstanceAttribute', 'DescribeEngineVersion', 'DescribeDBInstanceNetInfo', 'SwitchInstanceHA', 'RebootProxy', 'UpgradeProxy'], 'type' => 'directory', 'title' => 'Instance management', ], [ 'children' => ['DescribeIntranetAttribute'], 'type' => 'directory', 'title' => 'Connection management', ], [ 'children' => ['DescribePrice', 'TransformInstanceChargeType'], 'type' => 'directory', 'title' => 'Renewal management', ], [ 'children' => ['RestoreInstance', 'DescribeClusterBackupList'], 'type' => 'directory', 'title' => 'Backup and restoration', ], [ 'children' => ['DescribeDBInstanceMonitor', 'DescribeHistoryMonitorValues'], 'type' => 'directory', 'title' => 'Monitoring management', ], [ 'children' => ['DescribeServiceLinkedRoleExists'], 'type' => 'directory', 'title' => 'Log management', ], [ 'children' => ['ModifyInstanceSSL'], 'type' => 'directory', 'title' => 'Network security', ], [ 'children' => ['DescribeInstanceConfig', 'DescribeParameters'], 'type' => 'directory', 'title' => 'Parameter management', ], [ 'children' => ['DescribeActiveOperationTaskCount', 'DescribeActiveOperationMaintenanceConfig', 'ModifyActiveOperationMaintainConfig'], 'type' => 'directory', 'title' => 'Operations and maintenance task management', ], [ 'children' => ['ModifyEventInfo', 'DescribeHistoryEventsStat'], 'type' => 'directory', 'title' => 'Event management', ], [ 'children' => ['ModifyBackupExpireTime', 'CreateTairKVCacheVNode', 'DescribeTairKVCacheInferInstances', 'TransformToEcs', 'ModifyDBInstanceMonitor', 'DescribeTags', 'DescribeDbInstanceConnectivity', 'CreateAccount', 'CreateBackup', 'DeleteBackup', 'DescribeBackups', 'DescribeGlobalSecurityIPGroup', 'DescribeHistoryEvents', 'DescribeHistoryTasksStat'], 'type' => 'directory', 'title' => 'Other', ], [ 'children' => [ 'AddShardingNode', 'AllocateDirectConnection', 'AllocateInstancePublicConnection', 'CancelActiveOperationTasks', 'CheckCloudResourceAuthorized', 'CreateCacheAnalysisTask', 'CreateGlobalSecurityIPGroup', 'CreateInstanceMultiVIP', 'CreateParameterGroup', 'CreateTairSkvDdbTable', 'CreateTairSkvDdbWorkspace', 'DeleteAccount', 'DeleteGlobalSecurityIPGroup', 'DeleteInstance', 'DeleteParameterGroup', 'DescribeAccounts', 'DescribeActiveOperationTask', 'DescribeActiveOperationTasks', 'DescribeAuditLogConfig', 'DescribeAuditRecords', 'DescribeAvailableResource', 'DescribeBackupPolicy', 'DescribeBackupTasks', 'DescribeCacheAnalysisReport', 'DescribeCacheAnalysisReportList', 'DescribeClusterMemberInfo', 'DescribeDBNodeDirectVipInfo', 'DescribeDedicatedClusterInstanceList', 'DescribeEncryptionKey', 'DescribeEncryptionKeyList', 'DescribeGlobalDistributeCache', 'DescribeGlobalSecurityIPGroupRelation', 'DescribeHistoryTasks', 'DescribeInstanceAutoRenewalAttribute', 'DescribeInstanceMultiVIP', 'DescribeInstanceSSL', 'DescribeInstanceTDEStatus', 'DescribeInstancesOverview', 'DescribeLogicInstanceTopology', 'DescribeMonitorItems', 'DescribeParameterGroup', 'DescribeParameterGroupSupportParam', 'DescribeParameterGroupTemplateList', 'DescribeParameterGroups', 'DescribeParameterModificationHistory', 'DescribeParameterTemplates', 'DescribeRegions', 'DescribeRoleZoneInfo', 'DescribeRunningLogRecords', 'DescribeSecurityGroupConfiguration', 'DescribeSecurityIps', 'DescribeSlowLogRecords', 'DescribeTairSkvDdbTable', 'DescribeTairSkvDdbTableSchema', 'DescribeTaskDetail', 'DescribeZones', 'FlushExpireKeys', 'FlushInstance', 'FlushInstanceForDB', 'GrantAccountPrivilege', 'InitializeKvstorePermission', 'ListTagResources', 'LockDBInstanceWrite', 'MasterNodeShutDownFailOver', 'MigrateToOtherZone', 'ModifyAccountDescription', 'ModifyAccountPassword', 'ModifyActiveOperationTask', 'ModifyActiveOperationTasks', 'ModifyAuditLogConfig', 'ModifyBackupPolicy', 'ModifyDBInstanceAutoUpgrade', 'ModifyDBInstanceConnectionString', 'ModifyGlobalSecurityIPGroup', 'ModifyGlobalSecurityIPGroupName', 'ModifyGlobalSecurityIPGroupRelation', 'ModifyInstanceAttribute', 'ModifyInstanceAutoRenewalAttribute', 'ModifyInstanceBandwidth', 'ModifyInstanceConfig', 'ModifyInstanceMaintainTime', 'ModifyInstanceMajorVersion', 'ModifyInstanceMinorVersion', 'ModifyInstanceNetExpireTime', 'ModifyInstanceParameter', 'ModifyInstanceSpec', 'ModifyInstanceTDE', 'ModifyInstanceVpcAuthMode', 'ModifyIntranetAttribute', 'ModifyParameterGroup', 'ModifyResourceGroup', 'ModifySecurityGroupConfiguration', 'ModifySecurityIps', 'ModifyTaskInfo', 'ReleaseDirectConnection', 'ReleaseInstancePublicConnection', 'RemoveSubInstance', 'RenewAdditionalBandwidth', 'RenewInstance', 'ResetAccountPassword', 'RestartInstance', 'SwitchInstanceProxy', 'SwitchInstanceZoneFailOver', 'SwitchNetwork', 'SyncDtsStatus', 'TagResources', 'UnlockDBInstanceWrite', 'UntagResources', ], 'title' => 'Others', 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AddShardingNode' => [ 'summary' => 'Adds one or more data shards to a Tair cluster instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '56342', 'abilityTreeNodes' => ['FEATUREkvstoreDER7E8', 'FEATUREkvstore6PLKNO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'ShardCount', 'in' => 'query', 'schema' => ['description' => 'The number of data shards that you want to add. Default value: **1**.'."\n" ."\n" .'> The instance can contain 2 to 256 data shards. You can add up to 64 data shards at a time. Make sure that the number of shards does not exceed this limit.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '4096', 'minimum' => '1', 'example' => '2', 'default' => '1', 'title' => ''], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" ."\n" .'* **true**: enables auto-renewal. Make sure that your account has sufficient balance.'."\n" .'* **false**: disables auto-renewal. You must manually renew the instance in the console before the instance expires. For more information, see [Instance renewal](~~26352~~).'."\n" ."\n" .'> Default value: **true**.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'true', 'title' => ''], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => ['description' => 'The ID of the coupon.'."\n", 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'default' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => ['description' => 'The business information. This is an additional parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '000000000', 'title' => ''], ], [ 'name' => 'SourceBiz', 'in' => 'query', 'schema' => ['description' => 'The source of the operation. This parameter is used only for internal maintenance. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SDK', 'title' => ''], ], [ 'name' => 'ForceTrans', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable forced transmission during a configuration change. Valid values:'."\n" ."\n" .'* **false** (default): Before the configuration change, the system checks the minor version of the instance. If the minor version of the instance is outdated, an error is reported. You must update the minor version of the instance and try again.'."\n" .'* **true**: The system skips the version check and directly performs the configuration change.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The vSwitch ID. You can specify a different vSwitch within the same virtual private cloud (VPC). In this case, the new data shards are created in the specified vSwitch. If you do not specify this parameter, the new data shards are created in the original vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B79C1A90-495B-4E99-A2AA-A4DB13B8****', 'title' => ''], 'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20741011111111', 'title' => ''], 'NodeIds' => [ 'description' => 'The IDs of the data shards.'."\n", 'type' => 'array', 'items' => ['description' => 'The ID of the data shard.'."\n", 'type' => 'string', 'example' => 'r-8vb0i6z4npbxrf****-db-4', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B79C1A90-495B-4E99-A2AA-A4DB13B8****\\",\\n \\"OrderId\\": 20741011111111,\\n \\"NodeIds\\": [\\n \\"r-8vb0i6z4npbxrf****-db-4\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B79C1A90-495B-4E99-A2AA-A4DB13B8****\\n r-8vb0i6z4npbxrf****-db-4\\n r-8vb0i6z4npbxrf****-db-5\\n 207794311111111\\n","errorExample":""}]', 'title' => 'AddShardingNode', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-08-30T07:49:37.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-04T12:58:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-03-02T02:42:53.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-09-16T08:10:04.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-09-16T08:10:04.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-06T06:09:05.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddShardingNode'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:AddShardingNode', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'description' => 'This operation is available only for cluster instances that use cloud disks.'."\n", ], 'AllocateDirectConnection' => [ 'summary' => 'Applies for a private endpoint for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '56343', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreSVC8RN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => ['description' => 'The prefix of the private endpoint. The prefix must start with a lowercase letter and can contain lowercase letters and digits. The prefix must be 8 to 40 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'redisdirect123', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => ['description' => 'The port number of the instance. Valid values: **1024** to **65535**. Default value: **6379**.'."\n", 'type' => 'string', 'required' => false, 'example' => '6379', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'NetTypeExists', 'errorMessage' => 'Specified net type already existed', 'description' => ''], ['errorCode' => 'InvalidConnType', 'errorMessage' => 'Specified DB instance conn type is not valid.', 'description' => ''], ['errorCode' => 'TaskHasExist', 'errorMessage' => 'The task already exists.', 'description' => ''], ['errorCode' => 'ConnectionStringAlreadyExists', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', 'description' => ''], ['errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', 'description' => 'The connection string is invalid. Use a different one.'], ['errorCode' => 'DirectConnectionAlreadyExists', 'errorMessage' => 'Specified instance direct connection already exists.', 'description' => ''], ['errorCode' => 'InvalidVPCParamGroup', 'errorMessage' => 'Specified vpc param group is not valid.', 'description' => ''], ['errorCode' => 'InvalidConnectionString', 'errorMessage' => 'ConnectionString is invalid, valid regex: ^\\w+$', 'description' => 'The prefix of the endpoint is invalid. The prefix must start with a lowercase letter and can contain lowercase letters and digits. The prefix can be 8 to 40 characters in length.'], ], 403 => [ ['errorCode' => 'UnsupportedEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => ''], ['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => ''], ['errorCode' => 'InstanceStatus.NotSupport', 'errorMessage' => 'Instance status does not support this operation.', 'description' => ''], ], [ ['errorCode' => 'InvalidDbInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","type":"json"}]', 'title' => 'AllocateDirectConnection', 'description' => 'Clients can bypass proxy nodes and use private endpoints to connect to cluster instances. This is similar to the connection to native Redis clusters. The direct connection mode can reduce communication overheads and the response time of Tair (Redis OSS-compatible).'."\n" ."\n" .'To call this operation, make sure that the instance meets the following requirements:'."\n" ."\n" .'* The instance is a cluster instance.'."\n" .'* The instance is deployed in classic mode.'."\n" .'* The instance is deployed in a virtual private cloud (VPC). If the instance is deployed in the classic network, you can call the [SwitchNetwork](~~473797~~) operation to change the network type to VPC.'."\n" .'* SSL encryption is disabled for the instance. If SSL encryption is enabled, you can call the [ModifyInstanceSSL](~~473838~~) operation to disable SSL encryption.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AllocateDirectConnection'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:AllocateDirectConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'AllocateInstancePublicConnection' => [ 'summary' => 'Applies for a public endpoint for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '56344', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => ['description' => 'The prefix of the public endpoint. The prefix must start with a lowercase letter and can contain lowercase letters and digits. The prefix can be 8 to 40 characters in length.'."\n" ."\n" .'> The endpoint is in the `.redis.rds.aliyuncs.com` format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => ['description' => 'The service port number of the instance. Valid values: **1024** to **65535**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6379', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '20C8341E-B5AD-4B24-BD82-D73241522ABF', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingInstanceId', 'errorMessage' => 'InstanceId is mandatory for this action.', 'description' => ''], ['errorCode' => 'MissingConnectionString', 'errorMessage' => 'ConnectionStringPrefix is mandatory for this action.', 'description' => ''], ['errorCode' => 'MissingPort', 'errorMessage' => 'Port is mandatory for this action.', 'description' => ''], ['errorCode' => 'NetTypeExists', 'errorMessage' => 'Specified net type already existed.', 'description' => 'The specified network type already exists'], ['errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', 'description' => 'The connection string is invalid. Use a different one.'], ['errorCode' => 'NewSSLAlreadyEnabled', 'errorMessage' => 'new SSL have already been enabled.', 'description' => 'The instance has the new SSL certificate enabled.'], ], 403 => [ ['errorCode' => 'SSLNotSupportNetType', 'errorMessage' => 'SSL instance does not support create public network.', 'description' => 'SSL-enabled instances do not allow you to create public networks.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20C8341E-B5AD-4B24-BD82-D73241522ABF\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 20C8341E-B5AD-4B24-BD82-D73241522ABF\\r\\n","errorExample":""}]', 'title' => 'AllocateInstancePublicConnection', 'description' => 'You can also apply for public endpoints in the ApsaraDB for Redis console. For more information, see [Use a public endpoint to connect to an ApsaraDB for Redis instance](~~43850~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-02-26T09:46:19.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AllocateInstancePublicConnection'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:AllocateInstancePublicConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'CancelActiveOperationTasks' => [ 'summary' => 'Cancels O\\\\\\&M events at a time.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56346', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'Ids', 'in' => 'query', 'schema' => ['description' => 'The IDs of O\\&M events that you want to cancel at a time. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1508850,1508310,1507849,1506274,1505811', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Ids' => ['description' => 'The IDs of O\\&M events that are canceled at a time. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'example' => '1508850,1508310,1507849,1506274', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F16A51B0-436E-5B84-8326-A18AA150D1C4', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"1508850,1508310,1507849,1506274\\",\\n \\"RequestId\\": \\"F16A51B0-436E-5B84-8326-A18AA150D1C4\\"\\n}","type":"json"}]', 'title' => 'CancelActiveOperationTasks', 'description' => 'O\\&M events cannot be canceled in the following scenarios:'."\n" ."\n" .'* The allowCancel parameter is set to 0.'."\n" .'* The current time is later than the start time of the O\\&M event.'."\n" .'* The state value of the O\\&M event is not 3.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:CancelActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CheckCloudResourceAuthorized' => [ 'summary' => 'Queries whether a Tair (Redis OSS-compatible) instance has the permissions to use Key Management Service (KMS).', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'RoleArn', 'in' => 'query', 'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that you want to attach to your Tair (Redis OSS-compatible) instance. The ARN must be in the format of `acs:ram::$accountID:role/$roleName`. After the role is attached, your Tair (Redis OSS-compatible) instance can use KMS.'."\n" ."\n" .'> '."\n" ."\n" .'* `$accountID`: the ID of the Alibaba Cloud account. To view the account ID, log on to the Alibaba Cloud console, move the pointer over your profile picture in the upper-right corner of the page, and then click **Security Settings**.'."\n" ."\n" .'* `$roleName`: the name of the RAM role. Replace $roleName with **AliyunRdsInstanceEncryptionDefaultRole**.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AuthorizationState' => ['description' => 'Indicates whether the instance is authorized to use KMS. Valid values:'."\n" ."\n" .'* **0**: The instance is authorized to use KMS.'."\n" .'* **1**: The instance is not authorized to use KMS.'."\n" .'* **2**: KMS is not activated. For more information, see [Activate KMS](~~153781~~).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"AuthorizationState\\": 1,\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n A501A191-BD70-5E50-98A9-C2A486A82****\\n","errorExample":""}]', 'title' => 'CheckCloudResourceAuthorized', 'description' => '* For information about Transparent Data Encryption (TDE) and the usage notes of TDE, see [Enable TDE](~~265913~~).'."\n" .'* If the Tair (Redis OSS-compatible) instance is authorized to use KMS, you can call the [ModifyInstanceTDE](~~473859~~) operation to enable TDE.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-07-20T02:33:01.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckCloudResourceAuthorized'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:CheckCloudResourceAuthorized', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateAccount' => [ 'summary' => 'Create an account for an ApsaraDB for Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56348', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The name of the account. The name must meet the following requirements:'."\n" ."\n" .'* The name must start with a lowercase letter and can contain lowercase letters, digits, and underscores (\\_).'."\n" .'* The name can be up to 100 characters in length.'."\n" .'* The name cannot be one of the reserved words listed in the [Reserved words for Redis account names](https://www.alibabacloud.com/help/zh/redis/user-guide/create-and-manage-database-accounts#section-u3q-817-om3) section.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'demoaccount', 'title' => ''], ], [ 'name' => 'AccountPrivilege', 'in' => 'query', 'schema' => ['description' => 'The permissions of the account. Valid values:'."\n" ."\n" .'* **RoleReadOnly**: The account has read-only permissions.'."\n" .'* **RoleReadWrite**: The account has read and write permissions.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RoleReadOnly', 'title' => ''], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => 'The password of the account. The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and specific special characters. These special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'uWonno21****', 'title' => ''], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the account.'."\n" ."\n" .'* The description must start with a letter, and cannot start with `http://` or `https://`.'."\n" .'* The description can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" .'* The description must be 2 to 256 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testaccount', 'title' => ''], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => ['description' => 'The type of the account. Set the value to **Normal**, which indicates that the account is a standard account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], [ 'name' => 'SourceBiz', 'in' => 'query', 'schema' => ['description' => 'This parameter is used only for internal maintenance. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SDK', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABAF95F6-35C1-4177-AF3A-70969EBD****', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'AcountName' => ['description' => 'The name of the account.'."\n", 'type' => 'string', 'example' => 'demoaccount', 'title' => ''], 'AccountName' => ['description' => 'The account name.', 'type' => 'string', 'title' => '', 'example' => 'demoaccount'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAccountName.Duplicate', 'errorMessage' => 'Specified AccountName already exists in this instance.', 'description' => 'The error message returned because the account already exists.'], ['errorCode' => 'InvalidAccountName.Format', 'errorMessage' => 'Specified AccountName is not valid.', 'description' => ''], ['errorCode' => 'InvalidEngineVersion.Format', 'errorMessage' => 'Current EngineVersion does not support operations.', 'description' => 'The operation is not supported while the instance runs this engine version.'], ['errorCode' => 'InvalidAccountDescription.Format', 'errorMessage' => 'Specified AccountDescription is not valid.', 'description' => ''], ['errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified AccountPassword is not valid.', 'description' => ''], ['errorCode' => 'InvalidDBInstanceAccountMode.Format', 'errorMessage' => 'Current DB instance AccountMode does not support this operation.', 'description' => ''], ['errorCode' => 'InvalidAccountName.Forbid', 'errorMessage' => 'Specified AccountName is a keyword.', 'description' => ''], ['errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'Specified account privilege is not valid.', 'description' => ''], ], 403 => [ ['errorCode' => 'AccountLimitExceeded', 'errorMessage' => 'Exceeding the allowed amount of account.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABAF95F6-35C1-4177-AF3A-70969EBD****\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"AcountName\\": \\"demoaccount\\",\\n \\"AccountName\\": \\"demoaccount\\"\\n}","type":"json"}]', 'title' => 'Create Account', 'description' => '* This API supports only instances compatible with Redis 4.0 or later versions. '."\n" .'* The instance must be in the running status to use this API. '."\n" .'* You can create up to 18 accounts for an instance. '."\n" .'> For the corresponding console operation, see [Account Management](~~92665~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-10-27T13:01:39.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-07-11T12:25:18.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAccount'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'CreateBackup' => [ 'summary' => 'Create a data backup for an ApsaraDB Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '56349', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', 'schema' => ['description' => 'The expiration period of this manual backup, in days. Valid values range from 7 to 730. If you specify -1, the backup data will not expire during the instance lifetime. If you do not specify a value (default), the expiration period follows the current automatic backup policy.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'BackupJobID' => ['description' => 'The ID of the backup task.'."\n", 'type' => 'string', 'example' => '"1022,2480"', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2FF6158E-3394-4A90-B634-79C49184****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BackupJobID\\": \\"\\\\\\"1022,2480\\\\\\"\\",\\n \\"RequestId\\": \\"2FF6158E-3394-4A90-B634-79C49184****\\"\\n}","type":"json"}]', 'title' => 'Manual backup of data', 'description' => 'For the corresponding console operation of this API, see [backup and recovery](~~43886~~).', 'changeSet' => [ ['createdAt' => '2025-04-22T09:36:13.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-25T11:17:59.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-02T02:42:53.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackup'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateBackup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'CreateCacheAnalysisTask' => [ 'summary' => 'Creates a cache analysis task.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '56350', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'BBC1E3D6-7C88-4DF5-9A3D-0DB1E6D9****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support this operation.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BBC1E3D6-7C88-4DF5-9A3D-0DB1E6D9****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n BBC1E3D6-7C88-4DF5-9A3D-0DB1E6D9****\\r\\n","errorExample":""}]', 'title' => 'CreateCacheAnalysisTask', 'description' => 'This operation is no longer available. Use the new operation. For more information, see [Real-time key statistics and offline key analysis](~~184226~~).'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCacheAnalysisTask'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateCacheAnalysisTask', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'extraInfo' => ' ', ], 'CreateGlobalDistributeCache' => [ 'summary' => 'Converts an existing classic Tair memory-enhanced instance into the first sub-instance of a distributed instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56353', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'SeedSubInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n" ."\n" .'> This is a system parameter. You do not need to specify it.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'Specifies when to perform the operation. Valid values:'."\n" ."\n" .'- **Immediately**: Performs the operation immediately.'."\n" ."\n" .'- **MaintainTime**: Performs the operation during the maintenance window. This is the default value.'."\n" ."\n" .'> You can call the [ModifyInstanceMaintainTime](~~473775~~) operation to change the maintenance window of the instance.', 'type' => 'string', 'required' => false, 'default' => 'MaintainTime', 'enum' => ['Immediately', 'MaintainTime'], 'example' => 'Immediately', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E681E498-5A0D-44F2-B1A7-912DC3******', 'title' => ''], 'GlobalInstanceId' => ['description' => 'The ID of the distributed instance.', 'type' => 'string', 'example' => 'gr-8vbzg1y6m****t38p', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'r-8vb6ffc5****4ec4', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E681E498-5A0D-44F2-B1A7-912DC3******\\",\\n \\"GlobalInstanceId\\": \\"gr-8vbzg1y6m****t38p\\",\\n \\"InstanceId\\": \\"r-8vb6ffc5****4ec4\\"\\n}","type":"json"}]', 'title' => 'Convert an existing instance into the first child instance of a distributed instance', 'description' => 'This operation converts an existing instance into the first sub-instance of a distributed instance. The conversion also creates the distributed instance. The source instance must meet the following requirements:'."\n" ."\n" .'- The source instance must be a classic Tair [memory-enhanced](~~126164~~) instance.'."\n" ."\n" .'- If the source instance uses the cluster architecture, you must disable the direct connection mode. For more information, see [ReleasePublicConnection](~~150047~~).'."\n" ."\n" .'> Alternatively, you can call the [CreateInstance](~~473757~~) operation to create a new instance to use as the first sub-instance. This action also creates the distributed instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-05-30T06:19:29.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-04-22T13:23:13.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-25T07:29:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-03-02T02:42:53.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-16T08:29:21.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGlobalDistributeCache'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:CreateGlobalDistributeCache', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'CreateGlobalSecurityIPGroup' => [ 'summary' => 'Creates a global IP whitelist template.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREkvstoreRNHQKZ'], ], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'GlobalIgName', 'in' => 'query', 'schema' => ['description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" ."\n" .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" .'* The name must start with a letter and end with a letter or digit.'."\n" .'* The name must be 2 to 120 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_123', 'maxLength' => 120, 'minLength' => 2, 'title' => ''], ], [ 'name' => 'GIpList', 'in' => 'query', 'schema' => ['description' => 'The IP addresses in the IP whitelist template.'."\n" ."\n" .'> Separate multiple IP addresses with commas (,). The maximum number of IP addresses is 1,000.'."\n", 'type' => 'string', 'required' => true, 'example' => '192.168.0.1,10.10.10.10,172.16.0.1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], 'GlobalSecurityIPGroup' => [ 'description' => 'The information about the global IP whitelist template.'."\n", 'type' => 'array', 'items' => [ 'description' => '1'."\n", 'type' => 'object', 'properties' => [ 'GlobalSecurityGroupId' => ['description' => 'The ID of the IP whitelist template.'."\n", 'type' => 'string', 'example' => 'g-sdgwqyp4f5j1x3qk****', 'title' => ''], 'GlobalIgName' => ['description' => 'The name of the IP whitelist template.'."\n", 'type' => 'string', 'example' => 'test_123', 'title' => ''], 'GIpList' => ['description' => 'The IP addresses in the IP whitelist template.'."\n", 'type' => 'string', 'example' => '192.168.0.1,10.10.10.10,172.16.0.1', 'title' => ''], 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Missing input parameter'], ['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => 'The number of IP addresses in the list exceeds the limit'], ['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'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-sdgwqyp4f5j1x3qk****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1,10.10.10.10,172.16.0.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'CreateGlobalSecurityIPGroup', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGlobalSecurityIPGroup'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateGlobalSecurityIPGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '56354', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~473763~~) to query available regions. Use this parameter to specify the region in which to create the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Token', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. The token value is generated by the client and must be unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The name of the instance. The name must be 2 to 80 characters in length and must start with a letter or a Chinese character. The name cannot contain `@/:="<>{[]}` or spaces.', 'type' => 'string', 'required' => false, 'example' => 'apitest', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['description' => 'The password of the instance. The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, special characters, and digits. The following special characters are supported: `!@#$%^&*()_+-=`.', 'type' => 'string', 'required' => false, 'example' => 'Pass!123456', 'title' => ''], ], [ 'name' => 'Capacity', 'in' => 'query', 'schema' => ['description' => 'The storage capacity of the instance. Unit: MB.'."\n" ."\n" .'> You must specify at least one of the **Capacity** and **InstanceClass** parameters when you call this operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16384', 'title' => ''], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => ['description' => 'The instance type. For example, redis.master.small.default specifies a Community Edition (classic) standard architecture dual-replica 1 GB instance. For more information, see [Instance type overview](~~26350~~). '."\n" ."\n" .'> You must specify at least one of the **Capacity** and **InstanceClass** parameters when you call this operation.', 'type' => 'string', 'required' => false, 'example' => 'redis.master.small.default', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The primary zone ID. You can invoke [DescribeRegions](~~473763~~) to query active zones. Use this parameter to specify the zone in which to create the instance.'."\n" .'> You can also specify the SecondaryZoneId parameter to set the secondary zone. The primary and secondary nodes are deployed in the specified primary and secondary zones respectively, which implements a dual-center primary/secondary architecture in the same city. For example, set ZoneId to "cn-hangzhou-h" and SecondaryZoneId to "cn-hangzhou-g".', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou-h', 'title' => ''], ], [ 'name' => 'SecondaryZoneId', 'in' => 'query', 'schema' => ['description' => 'The secondary zone ID. You can call [DescribeZones](~~473764~~) to query available zones.'."\n" .'> The value of this parameter must be different from the value of ZoneId. You cannot set this parameter to the ID of a multi-zone.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-g', 'title' => ''], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method. Valid values:'."\n" .'* **PrePaid**: subscription.'."\n" .'* **PostPaid** (default): pay-as-you-go.', 'type' => 'string', 'required' => false, 'default' => 'PostPaid', 'enum' => ['PrePaid', 'PostPaid'], 'example' => 'PostPaid', 'title' => '', ], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => [ 'description' => 'The node type. Valid values:'."\n" .'* **MASTER_SLAVE**: high availability (dual-replica)'."\n" .'* **STAND_ALONE**: single replica'."\n" .'* **double**: dual-replica'."\n" .'* **single**: single replica'."\n" .'> For cloud-native instances, set this parameter to **MASTER_SLAVE** or **STAND_ALONE**. For classic instances, set this parameter to **double** or **single**.', 'type' => 'string', 'required' => false, 'default' => 'double', 'enum' => ['STAND_ALONE', 'MASTER_SLAVE', 'double', 'single'], 'example' => 'STAND_ALONE', 'title' => '', ], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type. Valid values:'."\n" .'* **VPC**: Virtual Private Cloud (VPC). This is the default value.', 'type' => 'string', 'required' => false, 'default' => 'VPC', 'enum' => ['VPC'], 'example' => 'VPC', 'title' => '', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The subscription period. Unit: months. Valid values: **1** to **9**, **12**, **24**, **36**, and **60**.'."\n" ."\n" .'> This parameter is available and required only when **ChargeType** is set to **PrePaid**.', 'type' => 'string', 'required' => false, 'pattern' => '^\\d+$', 'example' => '12', 'title' => ''], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => ['description' => 'The activity ID and business information.', 'type' => 'string', 'required' => false, 'example' => '000000000', 'title' => ''], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => ['description' => 'The coupon code. Default value: `default`.', 'type' => 'string', 'required' => false, 'default' => 'default', 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], ], [ 'name' => 'SrcDBInstanceId', 'in' => 'query', 'schema' => ['description' => 'To create an instance from a backup set of an existing instance, specify the instance ID of the source instance in this parameter.'."\n" .'> Then use the **BackupId**, **ClusterBackupId** (recommended for cloud-native cluster instances), or **RestoreTime** parameter to specify the backup set or point in time. This parameter must be used together with one of the preceding three parameters. The value is a string, not an array.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup set of the source instance. The system uses the data stored in the backup set to create the instance. You can invoke [DescribeBackups](~~473823~~) to query the BackupId. If the source instance is a cluster instance, specify the backup set IDs of all shards of the source instance, separated by commas (,). Example: "10\\*\\*,11\\*\\*,15\\*\\*".'."\n" .'> If your instance is a cloud-native architecture cluster instance, use [DescribeClusterBackupList](~~2679168~~) to query the cluster backup set ID, such as "cb-xx", and specify it in the ClusterBackupId request parameter to clone the cluster instance. This eliminates the need to specify individual shard backup set IDs.', 'type' => 'string', 'required' => false, 'example' => '111111111', 'title' => ''], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The instance type. Valid values:'."\n" .'* **Redis** (default)'."\n" .'* **Memcache**', 'type' => 'string', 'required' => false, 'default' => 'Redis', 'enum' => ['Redis', 'Memcache'], 'example' => 'Redis', 'title' => '', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'Redis **classic** engine version. Valid values:'."\n" .'* **2.8** (not recommended, [planned for end of support](~~2674657~~))'."\n" .'* **4.0** (not recommended)'."\n" .'* **5.0**'."\n" ."\n" .'Redis **cloud-native** engine version. Valid values:'."\n" .'* **5.0**'."\n" .'* **6.0** (recommended)'."\n" .'* **7.0**'."\n" ."\n" .'> Default value: **5.0**.', 'enumValueTitles' => ['4.0' => '4.0', '5.0' => '5.0', '6.0' => '6.0', '7.0' => '7.0', '2.8' => '2.8'], 'type' => 'string', 'required' => false, 'default' => '5.0', 'enum' => ['1.4', '2.8', '4.0', '5.0', '6.0', '7.0'], 'example' => '5.0', 'title' => '', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => ['description' => 'The internal network IP address of the new instance.'."\n" ."\n" .'> The internal network IP address must be within the vSwitch CIDR block to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => '172.16.0.***', 'title' => ''], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use a coupon. Valid values:'."\n" .'* **true**: uses a coupon.'."\n" .'* **false** (default): does not use a coupon.', 'type' => 'string', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" .'* **true**: enables auto-renewal.'."\n" .'* **false** (default): does not enable auto-renewal.', 'type' => 'string', 'required' => false, 'default' => 'false', 'enum' => ['true', 'false'], 'example' => 'true', 'title' => '', ], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => ['description' => 'The auto-renewal epoch. Unit: months. Valid values: **1**, **2**, **3**, **6**, and **12**.'."\n" ."\n" .'> This parameter is required when **AutoRenew** is set to **true**.', 'type' => 'string', 'required' => false, 'default' => '1', 'example' => '3', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-resourcegroupid1', 'title' => ''], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => ['description' => 'If flashback is enabled for the source instance, you can specify a point in time within the backup retention period. The system uses the backup data of the source instance at the specified point in time to create the instance. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2019-06-19T16:00:00Z', 'title' => ''], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the dedicated cluster. This parameter is required when you create an instance in a dedicated cluster.', 'type' => 'string', 'required' => false, 'example' => 'dhg-uv4fnk6r7zff****', 'title' => ''], ], [ 'name' => 'ShardCount', 'in' => 'query', 'schema' => ['description' => 'The number of shards. This parameter is applicable only to cloud-native instances. You can use this parameter to customize the number of shards.'."\n" ."\n" .'- 1: creates a non-cluster instance.'."\n" .'- A value greater than 1: creates a cluster instance.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '128', 'minimum' => '1', 'default' => '1', 'example' => '4', 'title' => ''], ], [ 'name' => 'ReplicaCount', 'in' => 'query', 'schema' => ['description' => 'The number of replica nodes in the primary zone. This parameter is applicable only to cloud-native cluster multi-replica instances. You can use this parameter to customize the number of replica nodes. Valid values: 1 to 4.'."\n" ."\n" .'> If you create a multi-zone instance, you can use this parameter together with the SlaveReplicaCount parameter to customize the number of replica nodes in the primary and secondary zones. The sum of this parameter and the SlaveReplicaCount parameter cannot exceed 4.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'SlaveReplicaCount', 'in' => 'query', 'schema' => ['description' => 'The number of replica nodes in the secondary zone.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'ReadOnlyCount', 'in' => 'query', 'schema' => ['description' => 'The number of read-only nodes in the primary zone. This parameter is applicable only to cloud-native read/write splitting instances.'."\n" .'* For standard architecture instances, valid values are 1 to 9.'."\n" .'* For cluster architecture instances, valid values are 1 to 4, which specifies the number of read-only nodes per data shard.'."\n" .'> If you create a multi-zone instance, you can use this parameter together with the SlaveReadOnlyCount parameter to customize the number of read-only nodes in the primary and secondary zones.'."\n" .'> - For standard architecture instances, the sum of this parameter and SlaveReadOnlyCount cannot exceed 9.'."\n" .'> - For cluster architecture instances, the sum of this parameter and SlaveReadOnlyCount cannot exceed 4.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '5', 'minimum' => '0', 'example' => '2', 'title' => ''], ], [ 'name' => 'SlaveReadOnlyCount', 'in' => 'query', 'schema' => ['description' => 'The number of read-only nodes in the secondary zone.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'GlobalInstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID of the distributed instance. This parameter is applicable only to Chinese site (aliyun.com).'."\n" ."\n" .' To append the new Redis instance as a child instance of a distributed instance, this parameter is active and required. For more information and console operations, see [Add a child instance to a distributed instance](~~106885~~).', 'type' => 'string', 'required' => false, 'example' => 'gr-bp14rkqrhac****', 'title' => ''], ], [ 'name' => 'GlobalInstance', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use the new instance as the first child instance of a distributed instance. This allows you to create a distributed instance. Valid values:'."\n" ."\n" .'* **true**: uses the instance as the first child instance.'."\n" .'* **false** (default): does not use the instance as the first child instance.'."\n" ."\n" .'> * To set this parameter to **true**, the new instance must be a Tair memory-optimized instance with a database DPI engine version of 5.0.'."\n" .'> * This parameter is applicable only to Chinese site (aliyun.com).', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => ['description' => 'The service port of the instance. Valid values: **1** to **65535**. Default value: **6379**.', 'type' => 'string', 'required' => false, 'maxLength' => 5, 'minLength' => 1, 'pattern' => '^\\d+$', 'example' => '6379', 'title' => ''], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform a dry run for this instance creation request. Valid values:'."\n" .'* **true**: performs a dry run without creating the instance. The system checks items such as the request parameters, request format, service limits, and available resources. If the check fails, the corresponding error is returned. If the check succeeds, the error code `DryRunOperation` is returned.'."\n" .'* **false** (default): sends the request. After the request passes the check, the instance is created.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], ], [ 'name' => 'GlobalSecurityGroupIds', 'in' => 'query', 'schema' => ['description' => 'The global IP whitelist templates for the instance. Separate multiple templates with commas (,). Duplicates are not allowed.'."\n" .'>This parameter is applicable only to cloud-native instances. Classic instances do not support the whitelist template feature.', 'type' => 'string', 'required' => false, 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], ], [ 'name' => 'Appendonly', 'in' => 'query', 'schema' => [ 'description' => 'The Append Only File (AOF) persistence parameter settings for the new instance. Valid values:'."\n" .'- **yes** (default): enables AOF persistence.'."\n" .'- **no**: disables AOF persistence.'."\n" .'> This parameter is applicable to classic instances. Cloud-native instances do not support specifying the AOF parameter.', 'enumValueTitles' => ['no' => 'Disables AOF.', 'yes' => 'Enables AOF.'], 'type' => 'string', 'required' => false, 'example' => 'yes', 'title' => '', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => ['description' => 'The prefix of the endpoint. The prefix must consist of lowercase letters and digits, start with a lowercase letter, and be 8 to 40 characters in length.'."\n" ."\n" .'> '."\n" .'> The endpoint is in the format of: .redis.rds.aliyuncs.com.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'ParamGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the parameter template. The ID is globally unique.>This parameter is applicable only to cloud-native instances.', 'type' => 'string', 'required' => false, 'example' => 'rpg-test**', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags of the instance.', 'type' => 'array', 'items' => [ 'description' => 'The object.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.'."\n" ."\n" .'> * **N** specifies the sequence number of the tag. A maximum of 20 tags can be attached to a single instance. For example, Tag.1.Key specifies the key of the first tag, and Tag.2.Key specifies the key of the second tag.'."\n" .'> * If the tag key does not exist, the tag is automatically created.', 'type' => 'string', 'required' => false, 'example' => 'testkey', 'title' => ''], 'Value' => ['description' => 'The value of the tag.'."\n" .'> **N** specifies the sequence number of the tag. For example, **Tag.1.Value** specifies the value of the first tag, and **Tag.2.Value** specifies the value of the second tag.', 'type' => 'string', 'required' => false, 'example' => 'testvalue', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], [ 'name' => 'ClusterBackupId', 'in' => 'query', 'schema' => ['description' => 'The cluster backup set ID, which is supported by some new cluster architecture instances. You can call [DescribeClusterBackupList](~~2679168~~) to obtain the ID.'."\n" .'* If supported, specify the cluster backup set ID. You do not need to specify the **BackupId** parameter.'."\n" .'* If not supported, specify the backup set IDs of all shards of the source instance in the BackupId parameter, separated by commas (,). Example: "2158\\*\\*\\*\\*20,2158\\*\\*\\*\\*22".', 'type' => 'string', 'required' => false, 'example' => 'cb-hyxdof5x9kqb****', 'title' => ''], ], [ 'name' => 'RecoverConfigMode', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to restore the account, kernel parameter (config), or whitelist information from the original backup set when you create an instance from a specified backup set. For example, to restore account information, set this parameter to `account`.'."\n" ."\n" .'The default value is empty, which indicates that the account, kernel parameter, and whitelist information is not restored from the original backup set.'."\n" .'> This parameter is applicable only to cloud-native instances, and the original backup set must contain the account, kernel parameter, or whitelist information. You can call [DescribeBackups](~~473823~~) to check whether the RecoverConfigMode parameter of the specified backup set contains the preceding information.', 'type' => 'string', 'required' => false, 'example' => 'whitelist,config,account', 'title' => ''], ], [ 'name' => 'InstanceEndpointType', 'in' => 'query', 'schema' => [ 'description' => 'The endpoint type used when you create a cloud-native dual-zone deployment read/write splitting instance. If this parameter is not explicitly committed, the default value is AzIndependentEndpoint.'."\n" ."\n" .'- **AzIndependentEndpoint**: **default value**. Zone-independent endpoints. The primary and secondary zones provide independent endpoints, which allow nearest access through different endpoints.'."\n" .'- **UnifiedEndpoint**: unified endpoint. A unified endpoint is provided to access nodes in both the primary and secondary zones, but cross-zone access may occur.'."\n" ."\n" .'>This parameter is applicable only to cloud-native dual-zone deployment read/write splitting instances. For other instance types, only zone-independent endpoints are supported. Even if UnifiedEndpoint is specified, it does not take effect.'."\n" ."\n" .'>The UnifiedEndpoint option is available only to users on the whitelist. If you are not on the whitelist and specify this parameter, the invocation returns an error. To request access, submit a ticket.', 'type' => 'string', 'default' => 'AzIndependentEndpoint', 'enum' => ['AzIndependentEndpoint', 'UnifiedEndpoint'], 'required' => false, 'example' => 'AzIndependentEndpoint', 'title' => '', ], ], [ 'name' => 'MaintainStartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the maintenance window. Specify the time in the HH:mmZ format in UTC. For example, to set the start time to 01:00 (UTC+8), specify `17:00Z`.'."\n" ."\n" .'> If this parameter is not specified, the default value is 02:00 (UTC+8), which is 18:00Z in UTC.', 'type' => 'string', 'required' => false, 'example' => '03:00Z', 'title' => ''], ], [ 'name' => 'MaintainEndTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the maintenance window. Specify the time in the HH:mmZ format in UTC. For example, to set the end time to 02:00 (UTC+8), specify `18:00Z`.'."\n" ."\n" .'> The interval between the start time and end time must be at least 1 hour.'."\n" ."\n" .'> If this parameter is not specified, the default value is 06:00 (UTC+8), which is 22:00Z in UTC.', 'type' => 'string', 'required' => false, 'example' => '07:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''], 'QPS' => ['description' => 'The queries per second (QPS). This value is the theoretical maximum for the current instance type.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''], 'Capacity' => ['description' => 'The storage capacity of the instance. Unit: MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '16384', 'title' => ''], 'ConnectionDomain' => ['description' => 'The internal network endpoint of the Redis instance.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', 'title' => ''], 'ChargeType' => ['description' => 'The billing method. Valid values:'."\n" .'* **PrePaid**: subscription.'."\n" .'* **PostPaid**: pay-as-you-go.', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''], 'NetworkType' => ['description' => 'The network type. Valid values:'."\n" .'* **CLASSIC**: classic network.'."\n" .'* **VPC**: VPC.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID, which is globally unique.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'Port' => ['description' => 'The Redis service port.', 'type' => 'integer', 'format' => 'int32', 'example' => '6379', 'title' => ''], 'Config' => ['description' => 'The detailed configuration of the instance.', 'type' => 'string', 'example' => '{\\"EvictionPolicy\\":\\"volatile-lru\\",\\"hash-max-ziplist-entries\\":512,\\"zset-max-ziplist-entries\\":128,\\"zset-max-ziplist-value\\":64,\\"set-max-intset-entries\\":512,\\"hash-max-ziplist-value\\":64}', 'title' => ''], 'RegionId' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'example' => 'cn-hongkong', 'title' => ''], 'EndTime' => ['description' => 'The time when the subscription instance expires. The time is in the yyyy-MM-ddTHH:mm:ssZ format in UTC.', 'type' => 'string', 'example' => '2019-01-18T16:00:00Z', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5DEA3CC9-F81D-4387-8E97-CEA40F09****', 'title' => ''], 'NodeType' => ['description' => 'The node type. Valid values:'."\n" .'* **STAND_ALONE**: single replica.'."\n" .'* **MASTER_SLAVE**: dual-replica.', 'type' => 'string', 'example' => 'MASTER_SLAVE', 'title' => ''], 'Connections' => ['description' => 'The maximum number of connections supported by the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], 'Bandwidth' => ['description' => 'The bandwidth limit of the instance. Unit: MB/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'apitest', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID of the instance.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], 'InstanceStatus' => ['description' => 'The current status of the instance. The return value is fixed as Creating.', 'type' => 'string', 'example' => 'Creating', 'title' => ''], 'PrivateIpAddr' => ['description' => 'The internal IP address of the instance.', 'type' => 'string', 'example' => '172.16.0.10', 'title' => ''], 'UserName' => ['description' => 'The account used to connect to the Redis instance. By default, an account named after the instance ID is included.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2084452111111', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ZoneIdNotFound', 'errorMessage' => 'Specify iz not support switch network.', 'description' => 'Unable to find Availability Zone'], ['errorCode' => 'InvalidShardInfo.Format', 'errorMessage' => 'Shard total number is out of range.', 'description' => ''], ['errorCode' => 'InvalidInstancelevel', 'errorMessage' => 'Specified Instance level dose not match gdc other member instance level.', 'description' => ''], ['errorCode' => 'InvalidBackupLogStatus', 'errorMessage' => 'Backup logs are not enabled for the specified source instance.', 'description' => ''], ['errorCode' => 'InvalidStatus', 'errorMessage' => 'Specified instance status is Modifying.', 'description' => 'Specified instance status is Modifying.'], ['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' => 'InvalidToken.Malformed', 'errorMessage' => 'The Specified parameter Token is not valid.', 'description' => ''], ['errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter InstanceName is not valid.', 'description' => ''], ['errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The Specified parameter Password is not valid.', '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' => 'PaymentMethodNotFound', 'errorMessage' => 'No payment method has been registered on the account.', 'description' => ''], ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Request uses a client token in a previous request but is not identical to that request.', 'description' => 'Idempotent check.'], ['errorCode' => 'QuotaNotEnough', 'errorMessage' => 'Quota not enough in this zone.', 'description' => ''], ['errorCode' => 'QuotaExceed', 'errorMessage' => 'Living afterpay instances quota exceed.', 'description' => ''], ['errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke vpc service failed.', 'description' => ''], ['errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify iz not support vpc.', 'description' => ''], ['errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The vpc does not cover the vswitch.', 'description' => ''], ['errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'The Specified vpc zone not supported.', 'description' => ''], ['errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', 'description' => ''], ['errorCode' => 'InstanceClass.NotMatch', 'errorMessage' => 'Current instance class and instance type is not match.', 'description' => ''], ['errorCode' => 'InvalidVPCId.NotFound', 'errorMessage' => 'Specified virtual vpc is not found.', 'description' => 'The specified VPC is not found. Check whether the VPC ID is correct.'], ['errorCode' => 'AccountMoneyValidateError', 'errorMessage' => 'Account money validate error.', 'description' => ''], ['errorCode' => 'RequestTokenConflict', 'errorMessage' => 'Specified request token conflict.', 'description' => ''], ['errorCode' => 'InvalidIPNotInSubnet', 'errorMessage' => 'Error ip not in subnet.', 'description' => ''], ['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', 'description' => 'The error message returned because the instance engine version is invalid.'], ['errorCode' => 'Zone.Closed', 'errorMessage' => 'The specified zone is closed.', 'description' => ''], ['errorCode' => 'VSwithNotBelongToNotVpcFault', 'errorMessage' => 'The vSwitch does not belong to current vpc.', 'description' => ''], ['errorCode' => 'PayIllegalAgreement', 'errorMessage' => 'Pay mayi with holding agreement illegal.', 'description' => ''], ['errorCode' => 'IllegalParamError', 'errorMessage' => 'validateSaleConditionWithSubArticle failed.', 'description' => ''], ['errorCode' => 'CASH_BOOK_INSUFFICIENT', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method or maitain a minimum prepayment balance of INR 1000.', 'description' => ''], ['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The specified region is invalid.'], ['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => 'The request performs the pre-check operation and has passed the pre-check, and does not create an instance.'], ['errorCode' => 'ResourceGroupNotExist', 'errorMessage' => 'The Specified ResourceGroupId does not exist.', 'description' => ''], ], 403 => [ ['errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'Your account has not passed the real-name authentication yet.', 'description' => ''], ['errorCode' => 'AuthorizationFailure', 'errorMessage' => 'The request processing has failed due to authorization failure.', 'description' => ''], ['errorCode' => 'TokenServiceError', 'errorMessage' => 'The specified token is duplicated, please change it.', 'description' => ''], ], [ ['errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', 'description' => 'The specified storage specification does not exist.'], ['errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The Specified vSwitchId zone not supported.', 'description' => ''], ['errorCode' => 'InvalidVpcIdOrVswitchId.NotSupported', 'errorMessage' => 'The Specified vpcId or vSwitchId not supported.', 'description' => ''], ], ], 'title' => 'Create an instance', 'summary' => 'Creates a Redis Community Edition classic instance, a Redis Community Edition cloud-native architecture instance, or a Tair memory-optimized classic instance. To create a cloud-native architecture Tair instance, call the CreateTairInstance operation.', 'description' => 'Before you invoke this operation, make sure that you fully understand the billing methods and [pricing](~~54532~~) of ApsaraDB for Tair (Redis® OSS-Compatible).'."\n" ."\n" .'This operation creates Redis Community Edition instances and Tair memory-optimized classic instances. To create a Tair cloud-native instance, invoke the [CreateTairInstance](~~473770~~) operation.'."\n" ."\n" .'> For the corresponding console operations and instance selection recommendations, see [Create a Redis instance](~~26351~~).', 'requestParamsDescription' => 'The following example shows a request to create a Redis 7.0 cluster instance.'."\n" .'```'."\n" .'{'."\n" .' "RegionId": "ap-southeast-1",'."\n" .' "InstanceName": "apitest",'."\n" .' "Password": "D****23",'."\n" .' "ZoneId": "ap-southeast-1a",'."\n" .' "ChargeType": "PrePaid",'."\n" .' "InstanceClass": "redis.shard.with.proxy.small.ce",'."\n" .' "NetworkType": "VPC",'."\n" .' "Period": "1",'."\n" .' "InstanceType": "Redis",'."\n" .' "EngineVersion": "7.0",'."\n" .' "ShardCount": 4,'."\n" .' "SourceIp": "10.10.10.10"'."\n" .'}'."\n" .'```', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2026-03-04T14:05:32.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-09-16T03:49:29.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-05-19T08:42:57.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-05-19T05:34:40.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-10-09T05:56:54.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-05-23T02:14:08.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-05-10T07:34:05.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-12T03:32:04.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-05T08:10:39.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-28T06:34:49.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-24T06:02:23.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-26T06:04:21.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-23T11:16:53.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-03T08:17:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-23T11:38:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-15T03:42:17.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-28T16:26:44.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-02-28T16:26:44.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-02-22T15:01:44.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2022-01-04T12:21:14.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-12-08T07:53:00.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-12-07T04:43:13.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '15', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateInstance'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateInstance', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:InstanceClass', 'validationType' => 'always'], ['conditionKey' => 'kvstore:Appendonly', 'validationType' => 'always'], ['conditionKey' => 'kvstore:InstanceType', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VpcId\\": \\"vpc-bp1nme44gek34slfc****\\",\\n \\"QPS\\": 100000,\\n \\"Capacity\\": 16384,\\n \\"ConnectionDomain\\": \\"r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"Port\\": 6379,\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"EvictionPolicy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"volatile-lru\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hash-max-ziplist-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"zset-max-ziplist-entries\\\\\\\\\\\\\\":128,\\\\\\\\\\\\\\"zset-max-ziplist-value\\\\\\\\\\\\\\":64,\\\\\\\\\\\\\\"set-max-intset-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"hash-max-ziplist-value\\\\\\\\\\\\\\":64}\\",\\n \\"RegionId\\": \\"cn-hongkong\\",\\n \\"EndTime\\": \\"2019-01-18T16:00:00Z\\",\\n \\"VSwitchId\\": \\"vsw-bp1e7clcw529l773d****\\",\\n \\"RequestId\\": \\"5DEA3CC9-F81D-4387-8E97-CEA40F09****\\",\\n \\"NodeType\\": \\"MASTER_SLAVE\\",\\n \\"Connections\\": 10000,\\n \\"Bandwidth\\": 32,\\n \\"InstanceName\\": \\"apitest\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"InstanceStatus\\": \\"Creating\\",\\n \\"PrivateIpAddr\\": \\"172.16.0.10\\",\\n \\"UserName\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"OrderId\\": 2084452111111\\n}","type":"json"}]', ], 'CreateInstanceMultiVIP' => [ 'summary' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '267592', 'abilityTreeNodes' => ['FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'AddCount', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '52D901ED-E0A5-42FB-B9DB-39C295C3****'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateInstanceMultiVIP', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52D901ED-E0A5-42FB-B9DB-39C295C3****\\"\\n}","type":"json"}]', ], 'CreateInstances' => [ 'summary' => 'Creates classic edition instances of ApsaraDB for Tair (Redis-compatible) in a batch.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '56356', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'Instances', 'in' => 'query', 'schema' => ['description' => 'The configurations of the new instances, specified in JSON format. For more information, see the details of the Instances parameter.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{'."\n" .' "RegionId": "cn-hangzhou",'."\n" .' "izNo": "cn-hangzhou-b",'."\n" .' "quantity": 1,'."\n" .' "instanceType": "Redis",'."\n" .' "instanceClass": "redis.logic.sharding.1g.2db.0rodb.4proxy.default",'."\n" .' "EngineVersion": "5.0", '."\n" .' "ChargeType":"PrePaid",'."\n" .' "Period":"1",'."\n" .' "networkType": "VPC" ,'."\n" .' "vpcId": "vpc-2zex6u1nu32k3ux35oxxx", '."\n" .' "vSwitchId": "vsw-2zesk464e647104kw3xxx"'."\n" .'}]', 'title' => ''], ], [ 'name' => 'Token', 'in' => 'query', 'schema' => ['description' => 'A client-generated token to ensure request idempotence. The value must be unique across requests, case-sensitive, and up to 64 ASCII characters long.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" .'\\* **true**: Enables automatic payment. This is the default value.'."\n" .'\\* **false**: Disables automatic payment. You must go to the console to complete the payment. In the top navigation bar, choose **Expenses** > **Renewal Management**. In the navigation pane on the left, click **Or*er Management** > **My Or*ers**, find the or*er, and then complete the payment.'."\n" .'\\> This parameter is valid only when **ChargeType** is set to **PrePaid** in **Instances**.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => 'true', 'title' => ''], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => ['description' => 'Additional business information.', 'type' => 'string', 'required' => false, 'example' => '000000000', 'title' => ''], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => ['description' => 'The coupon code. The default value is `youhuiquan_promotion_option_id_for_blank`.', 'type' => 'string', 'required' => false, 'default' => 'youhuiquan_promotion_option_id_for_blank', 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The Redis-compatible engine version for the instance. Valid values: **4.0** and **5.0**. The default value is **5.0**.', 'type' => 'string', 'required' => false, 'default' => '2.8', 'enum' => ['2.8', '4.0', '5.0'], 'example' => '5.0', 'title' => '', ], ], [ 'name' => 'RebuildInstance', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to rebuild an instance from the recycle bin. Valid values:'."\n" .'\\* **true**: Rebuilds the instance.'."\n" .'\\* **false**: Does not rebuild the instance. This is the default value.'."\n" .'\\> This parameter is valid only when **SrcDBInstanceId** is specified in **Instances**.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" .'\\* **true**: Enables auto-renewal.'."\n" .'\\* **false**: Disables auto-renewal. This is the default value.'."\n" .'\\> This parameter is valid only when **ChargeType** is set to **PrePaid** in **Instances**.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-resourcegroupid1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '20905403119****', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****', 'title' => ''], 'InstanceIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'InstanceId' => [ 'description' => 'The IDs of the instances that are created.', 'type' => 'array', 'items' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'r-bp16e70a4338****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Zone.Closed', 'errorMessage' => 'Specified zone is closed.', 'description' => 'The specified Availability Zone is closed'], ['errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', 'description' => ''], ['errorCode' => 'InvalidToken.Malformed', 'errorMessage' => 'The Specified parameter "Token" is not valid.', 'description' => ''], ['errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter "InstanceName" is not valid.', 'description' => ''], ['errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The Specified parameter "Password" is not valid.', 'description' => 'The specified Password parameters do not meet the requirements'], ['errorCode' => 'InvalidInstances.Malformed', 'errorMessage' => 'The Specified parameter "Instances" is not valid.', 'description' => 'The Instances parameter passed in is invalid.'], ['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' => 'PaymentMethodNotFound', 'errorMessage' => 'No payment method has been registered on the account.', 'description' => ''], ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Request uses a client token in a previous request but is not identical to that request.', 'description' => 'Idempotent check.'], ['errorCode' => 'QuotaNotEnough', 'errorMessage' => 'Quota not enough in this zone.', 'description' => ''], ['errorCode' => 'QuotaExceed', 'errorMessage' => 'Living afterpay instances quota exceed.', 'description' => ''], ['errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke vpc service failed.', 'description' => ''], ['errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify iz not support vpc.', 'description' => ''], ['errorCode' => 'InvalidVpcIdRegion.NotSupported', 'errorMessage' => 'The Specified vpcId or vSwitchId not supported.', 'description' => ''], ['errorCode' => 'ResourceGroupNotExist', 'errorMessage' => 'The Specified ResourceGroupId does not exist. ', 'description' => ''], ], 403 => [ ['errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'Your account has not passed the real-name authentication yet.', 'description' => ''], ], [ ['errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', 'description' => 'The specified storage specification does not exist.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"20905403119****\\",\\n \\"RequestId\\": \\"561AFBF1-BE20-44DB-9BD1-6988B53E****\\",\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"r-bp16e70a4338****\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Batch Create Instances '."\n", 'description' => 'Before calling this API, review the billing methods and [pricing](~~54532~~) of ApsaraDB for Tair (Redis-compatible).'."\n" .'\\> This API supports only creating Classic Edition instances.'."\n" .'To create a single instance, use one of the following APIs:'."\n" .'\\> - [CreateInstance](~~473757~~): Creates open source Redis instances or DRAM-based Classic Edition instances of Tair.'."\n" .'\\> - [CreateTairInstance](~~473770~~): Creates Cloud-native Edition instances of Tair, including DRAM-based, persistent memory-optimized, and ESSD-based instances.', 'requestParamsDescription' => '| Parameter | Type | Required | Example value | Description |'."\n" .'| --------------- | ------- | -------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| RegionId | String | Yes | cn-hangzhou | The ID of the region in which to create the instance. You can call the [DescribeRegions](~~473763~~) operation to query the latest list of available regions. |'."\n" .'| izNo | String | Yes | cn-hangzhou-b | The ID of the primary availability zone for the instance. You can find available availability zones by calling the [DescribeRegions](~~473763~~) operation. |'."\n" .'| quantity | Integer | No | 1 | The number of instances to create. Valid values: **1** to **300**. Default value: **1**. |'."\n" .'| instanceType | String | No | Redis | The instance type. Valid values:* **Redis** (default): An ApsaraDB for Tair (Redis-compatible) instance.
* **Memcache**: A Memcache instance. |'."\n" .'| instanceClass | String | No | redis.master.small.default | The instance class. For example, `redis.master.small.default` specifies a 1 GB dual-replica Community Edition (Classic Edition) instance that uses a standard architecture. For details, see [Specification Query Guide](~~26350~~).
**Note** You must specify either this parameter or `Capacity`. |'."\n" .'| Capacity | Long | No | 16384 | The storage capacity of the instance, in MB. For details, see [Specification Query Guide](~~26350~~).
**Note** You must specify either this parameter or `InstanceClass`. |'."\n" .'| EngineVersion | String | No | 5.0 | The engine version of the instance. Valid values:* **5.0** (default)
* **4.0** |'."\n" .'| ChargeType | String | No | PrePaid | The billing method. Valid values:* **PrePaid**: Subscription.
* **PostPaid** (default): Pay-as-you-go. |'."\n" .'| Period | Long | No | 12 | The subscription duration in months. Valid values: **1** to **9**, **12**, **24**, **36**, and **60**.
**Note** This parameter is required only when the `ChargeType` parameter is set to `PrePaid`. |'."\n" .'| AutoRenew | String | No | true | Specifies whether auto-renewal is enabled. Valid values:* **true**: Enables auto-renewal.
* **false** (default): Disables auto-renewal.**Note** This parameter is effective only when the `ChargeType` parameter is set to `PrePaid`. |'."\n" .'| InstanceName | String | No | apitest | The name of the instance. The name must meet the following requirements:* Must be 2 to 80 characters long and start with an uppercase or lowercase letter or a Chinese character.
* Cannot contain spaces or the following special characters: @/:=<>{\\[]} |'."\n" .'| Password | String | No | Pass!123456 | The password for the instance. The password must meet the following requirements:* Must be 8 to 32 characters in length.
* Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
* Supported special characters: !@#$%^&\\*()\\_+-= |'."\n" .'| networkType | String | No | VPC | The network type. Valid value: **VPC**. |'."\n" .'| vpcId | String | No | vpc-bp1nme44gek34slfc**** | The ID of the VPC for the instance. You can call the VPC operation [DescribeVpcs](~~35739~~) to query available VPCs. |'."\n" .'| vSwitchId | String | No | vsw-bp1e7clcw529l773d**** | The ID of the vSwitch that belongs to the specified VPC. You can call the VPC operation [DescribeVSwitches](~~35739~~) to query available vSwitches. |'."\n" .'| NodeType | String | No | MASTER_SLAVE | The node type. Valid values:* **STAND\\_ALONE**: single-replica.
* **MASTER\\_SLAVE** (default): high availability (dual-replica). |'."\n" .'| SrcDBInstanceId | String | No | r-bp1zxszhcgatnx**** | The ID of the source instance. You can call the [DescribeInstances](~~473778~~) operation to find instance IDs.
**Note** This parameter is required only when creating an instance from a source instance\'s backup. |'."\n" .'| BackupId | String | No | 111111111 | The ID of the backup set. You can call the [DescribeBackups](~~473823~~) operation to find backup set IDs.
**Note** When creating an instance from a source instance\'s backup, you must specify both this parameter and `SrcDBInstanceId`. |'."\n" .'| RebuildInstance | String | No | false | Specifies whether to restore the source instance from the Recycle Bin. Valid values:* **true**: Rebuilds and restores the source instance.
* **false** (default): Does not rebuild and restore the source instance.**Note** If you specify this parameter, you must also specify the `SrcDBInstanceId` parameter. |'."\n" ."\n" .'```'."\n" .'[{'."\n" .' "RegionId": "cn-hangzhou",'."\n" .' "izNo": "cn-hangzhou-b",'."\n" .' "quantity": 1,'."\n" .' "instanceType": "Redis",'."\n" .' "instanceClass": "redis.logic.sharding.1g.2db.0rodb.4proxy.default",'."\n" .' "EngineVersion": "5.0",'."\n" .' "ChargeType": "PrePaid",'."\n" .' "Period": 1,'."\n" .' "networkType": "VPC" , '."\n" .' "vpcId": "vpc-2zex6u1nu32k3ux35xxxx", '."\n" .' "vSwitchId": "vsw-2zesk464e647104kwxxxx"'."\n" .'}]'."\n" .'```', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-02-22T15:01:44.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstances'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateInstances', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:InstanceClass', 'validationType' => 'conditional'], ['conditionKey' => 'kvstore:InstanceType', 'validationType' => 'conditional'], ['conditionKey' => 'kvstore:Appendonly'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/*'], ], ], ], ], ], 'CreateParameterGroup' => [ 'summary' => 'Creates a parameter template.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => ['description' => 'The service category. Valid values:'."\n" ."\n" .'* **standard**: Community Edition'."\n" .'* **enterprise**: Enhanced Edition (Tair)'."\n", 'type' => 'string', 'required' => true, 'example' => 'enterprise', 'title' => ''], ], [ 'name' => 'EngineType', 'in' => 'query', 'schema' => ['description' => 'The engine type. Valid values:'."\n" ."\n" .'* **redis**: ApsaraDB for Redis Community Edition instance or Tair DRAM-based instance'."\n" .'* **tair_pena**: Tair persistent memory-optimized instance'."\n" .'* **tair_pdb**: Tair ESSD/SSD-based instance'."\n", 'type' => 'string', 'required' => true, 'example' => 'redis', 'title' => ''], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => ['description' => 'The compatible engine version. Valid values:'."\n" ."\n" .'* For ApsaraDB for Redis Community Edition instances, set the parameter to **5.0**, **6.0**, or **7.0**.'."\n" .'* For Tair DRAM-based instances that are compatible with Redis 5.0, 6.0, or 7.0, set the parameter to **5.0**, **6.0**, or **7.0**.'."\n" .'* For Tair persistent memory-optimized instances that are compatible with Redis 6.0, set the parameter to **1.0**.'."\n" .'* For Tair ESSD-based instances that are compatible with Redis 6.0, set the parameter to **1.0**. For Tair SSD-based instances that are compatible with Redis 6.0, set the parameter to **2.0**.'."\n", 'type' => 'string', 'required' => true, 'example' => '6.0', 'title' => ''], ], [ 'name' => 'ParameterGroupName', 'in' => 'query', 'schema' => ['description' => 'The new name of the parameter template. The name must meet the following requirements:'."\n" ."\n" .'* The name can contain letters, digits, and underscores (\\_). It must start with a letter and cannot contain Chinese characters.'."\n" .'* The name can be 8 to 64 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tw_test1', 'title' => ''], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => ['description' => 'A JSON-formatted object that specifies the parameter-value pairs. Format: {"Parameter 1":"Value 1","Parameter 2":"Value 2"...}. The specified value overwrites the original content.'."\n" ."\n" .'> The parameters that can be added for different editions are displayed in the console.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"hz":"15","#no_loose_disabled-commands":"flushall"}', 'title' => ''], ], [ 'name' => 'ParameterGroupDesc', 'in' => 'query', 'schema' => ['description' => 'The description of the parameter template. The description must be 0 to 200 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '62DA5BE5-F9C9-527C-ACCB-4D783C297A3A'], 'ParamGroupId' => ['description' => 'The parameter template ID.'."\n", 'type' => 'string', 'example' => 'g-51ii2ienn0dg0xi8****', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The parameter is invalid.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"62DA5BE5-F9C9-527C-ACCB-4D783C297A3A\\",\\n \\"ParamGroupId\\": \\"g-51ii2ienn0dg0xi8****\\"\\n}","type":"json"}]', 'title' => 'CreateParameterGroup', 'description' => '参数模板仅适用于云原生部署模式实例（原云盘实例）。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateParameterGroup'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateParameterGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateTairInstance' => [ 'summary' => 'Create a cloud-native Tair Enterprise Edition instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '56360', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where you want to create the instance. You can call the [DescribeRegions](~~473763~~) operation to query available regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The name of the instance. The name must meet the following requirements:'."\n" ."\n" .'- It must be 2 to 80 characters in length.'."\n" ."\n" .'- It must start with an uppercase or lowercase letter or a Chinese character. It cannot contain spaces or the following special characters: `@/:=”<>{[]}`.', 'type' => 'string', 'required' => false, 'example' => 'apitest', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['description' => 'The password of the instance. The password must meet the following requirements:'."\n" ."\n" .'- It must be 8 to 32 characters in length.'."\n" ."\n" .'- It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The supported special characters are `!@#$%^&*()_+-=`.', 'type' => 'string', 'required' => false, 'example' => 'Pass!123456', 'title' => ''], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => ['description' => 'The instance type. For more information, see the following topics:'."\n" ."\n" .'- [Memory-enhanced instance types](~~2527112~~)'."\n" ."\n" .'- [Persistent memory-optimized instance types](~~2527110~~)'."\n" ."\n" .'- [Disk-based instance types](~~2527111~~)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tair.scm.standard.4m.32d', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the primary zone where you want to create the instance. You can call the [DescribeRegions](~~473763~~) operation to query available zones.'."\n" ."\n" .'> You can also specify a secondary zone by using the `SecondaryZoneId` parameter. This deploys the primary and replica nodes in different zones within the same region for a high-availability primary/replica architecture. For example, you can set `ZoneId` to `cn-hangzhou-h` and `SecondaryZoneId` to `cn-hangzhou-g`.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou-h', 'title' => ''], ], [ 'name' => 'SecondaryZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the secondary zone. You can call the [DescribeRegions](~~473763~~) operation to query available zones.'."\n" ."\n" .'> The value of this parameter cannot be the same as the value of the `ZoneId` parameter. You cannot specify a multi-zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-g', 'title' => ''], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'- **PrePaid** (default): The subscription billing method.'."\n" ."\n" .'- **PostPaid**: The pay-as-you-go billing method.', 'enumValueTitles' => ['PostPaid' => 'PostPaid', 'PrePaid' => 'PrePaid'], 'type' => 'string', 'required' => false, 'default' => 'PrePaid', 'enum' => ['PrePaid', 'PostPaid'], 'example' => 'PrePaid', 'title' => '', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Virtual Private Cloud (VPC) where you want to create the instance. You can call the [DescribeVpcs](~~35739~~) operation to query available VPCs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch in the specified VPC. You can call the VPC API operation [DescribeVSwitches](~~35739~~) to obtain the vSwitch ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The subscription duration, in months. Valid values: **1**, **2**, **3**, **4**, **5**, **6**, 7, 8, 9, 12, 24, 36, and 60.'."\n" ."\n" .'> This parameter is required only when you set the `ChargeType` parameter to `PrePaid`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => ['description' => 'The business information. This can be the ID of a promotion or a business context.', 'type' => 'string', 'required' => false, 'example' => '000000000', 'title' => ''], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => ['description' => 'The coupon code.', 'type' => 'string', 'required' => false, 'default' => 'default', 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], ], [ 'name' => 'SrcDBInstanceId', 'in' => 'query', 'schema' => ['description' => 'To create an instance from a backup set of an existing instance, specify the ID of the source instance.'."\n" ."\n" .'> You must also specify the backup data by using one of the following parameters: **BackupId**, **ClusterBackupId**, or **RestoreTime**. We recommend that you use `ClusterBackupId` for cloud-native instances that use a cluster architecture.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup set from the source instance. The system creates a new instance based on the data in this backup set. You can call the [DescribeBackups](~~473823~~) operation to query the backup set ID. If the source instance is a cluster instance, you must specify the backup ID for each shard, separated by commas, for example, "10\\*\\*,11\\*\\*,15\\*\\*".'."\n" ."\n" .'> If your instance is a cloud-native cluster instance, we recommend that you call the [DescribeClusterBackupList](~~2679168~~) operation to query the cluster backup ID, such as `cb-xx`. Then, specify the cluster backup ID for the `ClusterBackupId` parameter to clone the cluster instance. This avoids the need to specify the backup ID of each shard.', 'type' => 'string', 'required' => false, 'example' => '2158****20', 'title' => ''], ], [ 'name' => 'ClusterBackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster backup set. Some instances that use the cluster architecture support cluster backup sets. You can call the [DescribeClusterBackupList](~~2679168~~) operation to query for cluster backup set IDs.'."\n" ."\n" .'- If this feature is supported, you can specify this parameter and leave the **BackupId** parameter empty.'."\n" ."\n" .'- If this feature is not supported, you must specify the backup ID of each shard of the source instance for the `BackupId` parameter. Separate the backup IDs with commas, for example, "2158\\*\\*\\*\\*20,2158\\*\\*\\*\\*22".', 'type' => 'string', 'required' => false, 'example' => 'cb-hyxdof5x9kqb****', 'title' => ''], ], [ 'name' => 'RecoverConfigMode', 'in' => 'query', 'schema' => ['description' => 'When creating an instance from a backup set, specifies whether to restore configurations such as account information (`account`), kernel parameters (`config`), and whitelists (`whitelist`) from the source backup set. To restore a specific configuration, specify its keyword. To restore multiple configurations, separate the keywords with commas.'."\n" ."\n" .'If this parameter is not specified, no configurations are restored from the source backup set.'."\n" ."\n" .'> This parameter applies only to cloud-native instances, and the source backup set must contain the specified configuration information. You can call the [DescribeBackups](~~473823~~) operation and check the `RecoverConfigMode` parameter in the response to check if the backup set contains the information.', 'type' => 'string', 'required' => false, 'example' => 'whitelist,config,account', 'title' => ''], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => ['description' => 'The private IP address of the instance.'."\n" ."\n" .'> The IP address must be within the CIDR block of the vSwitch to which the instance belongs. You can call the [DescribeVSwitches](~~35748~~) operation to query the CIDR block information.', 'type' => 'string', 'required' => false, 'example' => '172.16.88.***', 'title' => ''], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use a coupon. Valid values:'."\n" ."\n" .'- **true**: Use a coupon.'."\n" ."\n" .'- **false** (default): Do not use a coupon.', 'type' => 'string', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'- **true**: Enable auto-renewal.'."\n" ."\n" .'- **false** (default): Disable auto-renewal.', 'type' => 'string', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => ['description' => 'The auto-renewal duration. Unit: month. Valid values: **1**, **2**, **3**, **6**, and **12**.'."\n" ."\n" .'> This parameter is required only when the **AutoRenew** parameter is set to **true**.', 'type' => 'string', 'required' => false, 'default' => '1', 'example' => '3', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group to which the instance belongs.'."\n" ."\n" .'> - You can call the [ListResourceGroups](~~158855~~) operation or use the Resource Management console to query the IDs of resource groups. For more information, see [View basic information of a resource group](~~151181~~).'."\n" .'>'."\n" .'> - Before you change the resource group of an instance, you can call the [ListResources](~~158866~~) operation to view the current resource group of the instance.', 'type' => 'string', 'required' => false, 'maximum' => '4096', 'minimum' => '1', 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic payment. Set the value to **true**.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'enum' => ['true'], 'example' => 'true', 'title' => '', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token that ensures the idempotence of the request. The token must be unique among different requests. It is case-sensitive and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type. Valid values: **essd\\_pl1**, **essd\\_pl2**, and **essd\\_pl3**.'."\n" ."\n" .'> This parameter is required only when you set the **InstanceType** parameter to `tair_essd` to create a Tair instance that uses an Enhanced SSD (ESSD).', 'type' => 'string', 'required' => false, 'enum' => ['essd_pl0', 'essd_pl1', 'essd_pl2', 'essd_pl3'], 'example' => 'essd_pl1', 'title' => '', ], ], [ 'name' => 'Storage', 'in' => 'query', 'schema' => ['description' => 'The storage space of the disk-based instance. The valid values of this parameter vary based on the instance type. For more information, see [Disk-based instance types](~~2527111~~).'."\n" ."\n" .'> This parameter is required only when you set the **InstanceType** parameter to `tair_essd` to create a Tair instance that uses an ESSD. For Tair instances that use standard `SSD`s, the storage capacity is determined by the instance type and you do not need to specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], ], [ 'name' => 'ShardType', 'in' => 'query', 'schema' => [ 'description' => 'The architecture type of the instance. Valid values:'."\n" ."\n" .'- **MASTER\\_SLAVE** (default): The primary/replica architecture, which provides high availability.'."\n" ."\n" .'- **STAND\\_ALONE**: single-replica. This architecture uses a single node. If the node fails, data is lost, and the system automatically creates a new, empty instance. This architecture is supported only for **single-zone** deployments and does not support cluster or read/write splitting architectures.', 'type' => 'string', 'required' => false, 'default' => 'MASTER_SLAVE', 'enum' => ['STAND_ALONE', 'MASTER_SLAVE'], 'example' => 'MASTER_SLAVE', 'title' => '', ], ], [ 'name' => 'ShardCount', 'in' => 'query', 'schema' => ['description' => 'The number of shards in the instance. Valid values:'."\n" ."\n" .'- **1** (default): Creates a standard architecture instance with a single shard.'."\n" ."\n" .'- From **2** to **32**: Creates a cluster architecture instance with the specified number of shards.'."\n" ."\n" .'> You can specify a value from **2** to **32** for this parameter only when you set the **InstanceType** parameter to `tair_rdb` or `tair_scm`. Only memory-enhanced and persistent memory-optimized instances support the cluster architecture.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '128', 'minimum' => '1', 'default' => '1', 'example' => '2', 'title' => ''], ], [ 'name' => 'ReplicaCount', 'in' => 'query', 'schema' => ['description' => 'The number of replica nodes in the primary zone. This parameter is applicable only to cloud-native, multi-replica cluster instances. You can use this parameter to customize the number of replica nodes. Valid values: 1 to 4.'."\n" ."\n" .'> If you create a multi-zone instance, you can use this parameter and the `SlaveReplicaCount` parameter to customize the number of replica nodes in the primary and secondary zones. The sum of `ReplicaCount` and `SlaveReplicaCount` cannot exceed 4.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'SlaveReplicaCount', 'in' => 'query', 'schema' => ['description' => 'The number of replica nodes in the secondary zone.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'ReadOnlyCount', 'in' => 'query', 'schema' => ['description' => 'The number of read-only nodes in the primary zone. This parameter is applicable only to cloud-native instances that use the read/write splitting architecture.'."\n" ."\n" .'- If the instance uses the standard architecture, the valid values are 1 to 9.'."\n" ."\n" .'- If the instance uses the cluster architecture, specify the number of read-only nodes per shard. The valid values are 1 to 4.'."\n" ."\n" .'> If you create a multi-zone instance, you can use this parameter and the `SlaveReadOnlyCount` parameter to customize the number of read-only nodes in the primary and secondary zones.'."\n" .'>'."\n" .'> - If the instance uses the standard architecture, the sum of `ReadOnlyCount` and `SlaveReadOnlyCount` cannot exceed 9.'."\n" .'>'."\n" .'> - If the instance uses the cluster architecture, the sum of `ReadOnlyCount` and `SlaveReadOnlyCount` cannot exceed 4.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '5', 'minimum' => '1', 'example' => '5', 'title' => ''], ], [ 'name' => 'SlaveReadOnlyCount', 'in' => 'query', 'schema' => ['description' => 'The number of read-only nodes in the secondary zone.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database version. Default value: **1.0**. The valid values depend on the Tair instance series:'."\n" ."\n" .'- **tair\\_rdb**: Tair memory-enhanced instances are compatible with Redis 5.0, Redis 6.0, and Redis 7.0. Set the value to **5.0**, **6.0**, or **7.0**.'."\n" ."\n" .'- **tair\\_scm**: Tair persistent memory-optimized instances are compatible with Redis 6.0. Set the value to **1.0**.'."\n" ."\n" .'- **tair\\_essd**: Tair disk-based instances (ESSD/SSD) are compatible with Redis 6.0. Set the value to **1.0** to create an ESSD-based instance or **2.0** to create an SSD-based instance.', 'type' => 'string', 'required' => false, 'default' => '1.0', 'enum' => ['1.0', '5.0', '6.0', '2.0', '7.0'], 'example' => '1.0', 'title' => '', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The Tair instance series, which determines the storage medium. Valid values:'."\n" ."\n" .'- **tair\\_rdb**: memory-enhanced'."\n" ."\n" .'- **tair\\_scm**: persistent memory-optimized'."\n" ."\n" .'- **tair\\_essd**: disk-based', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enum' => ['tair_scm', 'tair_essd', 'tair_rdb', 'Redis', 'tair_skv'], 'example' => 'tair_scm', 'title' => '', ], ], [ 'name' => 'GlobalInstanceId', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to create the instance as a child instance in a distributed instance. By using this parameter, you can create a distributed instance.'."\n" ."\n" .'- To create the first child instance, set this parameter to **true**.'."\n" ."\n" .'- To create the second or third child instance, specify the ID of the distributed instance, such as `gr-bp14rkqrhac****`.'."\n" ."\n" .'- If you do not want to create a distributed instance, do not specify this parameter.'."\n" ."\n" .'> To be created as a child instance of a distributed instance, the new instance must be a Tair memory-enhanced instance.', 'type' => 'string', 'required' => false, 'example' => 'gr-bp14rkqrhac****', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags of the instance.', 'type' => 'array', 'items' => [ 'description' => 'The information about the tags.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.'."\n" ."\n" .'> A single request can contain up to five key-value pairs.', 'type' => 'string', 'required' => false, 'example' => 'key1_test', 'title' => ''], 'Value' => ['description' => 'The value of the tag.'."\n" ."\n" .'> **N** specifies the Nth tag in the request. For example, **Tag.1.Value** specifies the value of the first tag, and **Tag.2.Value** specifies the value of the second tag.', 'type' => 'string', 'required' => false, 'example' => 'value1_test', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform a precheck for this request. Valid values:'."\n" ."\n" .'- **true**: Performs a precheck and does not create the instance. The system checks the request parameters, request format, service limits, and available inventory. If the request fails the precheck, an error message is returned. If the request passes the precheck, the `DryRunOperation` error code is returned.'."\n" ."\n" .'- **false** (default): Sends a normal request and creates the instance after the request passes the precheck.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The service port of the instance. Valid values: 1 to 65535. Default value: 6379.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '65535', 'minimum' => '1024', 'exclusiveMinimum' => false, 'default' => '6379', 'required' => false, 'example' => '6379', 'title' => ''], ], [ 'name' => 'GlobalSecurityGroupIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the global IP whitelist templates for the instance. To specify multiple template IDs, separate them with commas. The IDs cannot be repeated.', 'type' => 'string', 'required' => false, 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], ], [ 'name' => 'ParamGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the parameter template. The instance is created by using the parameters defined in this template.', 'type' => 'string', 'required' => false, 'example' => 'g-50npzjcqb1ua6q6j****', 'title' => ''], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => ['description' => 'If point-in-time recovery (PITR) is enabled for the source instance, you can specify a point in time within the backup retention period. The system creates a new instance by using the backup data of the source instance at that point in time. Specify the time in the *yyyy-MM-dd*T*HH:mm:ss*Z format (UTC).', 'type' => 'string', 'required' => false, 'example' => '2021-07-06T07:25:57Z', 'title' => ''], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => ['description' => 'The prefix of the connection string. It must start with a lowercase letter, consist of lowercase letters and digits, and be 8 to 40 characters in length.'."\n" ."\n" .'> The full connection string is in the format of `-.redis.rds.aliyuncs.com`.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'InstanceEndpointType', 'in' => 'query', 'schema' => [ 'description' => 'The type of connection string to use when creating a cloud-native, dual-zone instance with the read/write splitting architecture. If you do not specify this parameter, the default value `AzIndependentEndpoint` is used.'."\n" ."\n" .'- **AzIndependentEndpoint** (**default**): Zone-specific connection string. The primary and secondary zones each provide an independent connection string, allowing clients to connect to the nearest zone.'."\n" ."\n" .'- **UnifiedEndpoint**: Unified connection string. A single connection string is provided to access nodes in both the primary and secondary zones, but this may cause cross-zone access.'."\n" ."\n" .'>'."\n" ."\n" .'This parameter applies only to cloud-native, dual-zone instances with the read/write splitting architecture. Other instance types support only zone-specific connection strings.'."\n" ."\n" .'>'."\n" ."\n" .'>'."\n" ."\n" .'The `UnifiedEndpoint` option is available only to users on a whitelist. If a non-whitelisted user specifies this value, the request fails. To request access, submit a ticket.'."\n" ."\n" .'>', 'type' => 'string', 'default' => 'AzIndependentEndpoint', 'enum' => ['AzIndependentEndpoint', 'UnifiedEndpoint'], 'required' => false, 'example' => 'AzIndependentEndpoint', 'title' => '', ], ], [ 'name' => 'MaintainStartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the maintenance window. Specify the time in the *HH:mm*Z format (UTC). For example, to start the maintenance at 01:00 (UTC+8), set this parameter to `17:00Z`.'."\n" ."\n" .'> If this parameter is not specified, the maintenance window starts at 18:00 UTC (02:00 UTC+8) by default.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'MaintainEndTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the maintenance window. Specify the time in the *HH:mm*Z format (UTC). For example, to end the maintenance at 02:00 (UTC+8), set this parameter to `18:00Z`.'."\n" ."\n" .'> The maintenance window must be at least one hour long.'."\n" ."\n" .'> If this parameter is not specified, the maintenance window ends at 22:00 UTC (06:00 UTC+8) by default.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'An object.', 'type' => 'object', 'properties' => [ 'QPS' => ['description' => 'The theoretical maximum number of read and write operations per second (QPS) for the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''], 'ConnectionDomain' => ['description' => 'The internal connection address.', 'type' => 'string', 'example' => 'r-bp13ac3d047b****.tairpena.rds.aliyuncs.com', 'title' => ''], 'ChargeType' => ['description' => 'The charge type. Valid values:'."\n" ."\n" .'- **PrePaid**: prepaid.'."\n" ."\n" .'- **PostPaid**: pay-as-you-go.', 'type' => 'string', 'example' => 'PrePaid', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'r-bp13ac3d047b****', 'title' => ''], 'Port' => ['description' => 'The instance port.', 'type' => 'integer', 'format' => 'int32', 'example' => '6379', 'title' => ''], 'Config' => ['description' => 'The detailed configuration of the instance, returned as a JSON string. For parameter details, see [Configuration parameters](~~43885~~).', 'type' => 'string', 'example' => '{\\"EvictionPolicy\\":\\"volatile-lru\\",\\"hash-max-ziplist-entries\\":512,\\"zset-max-ziplist-entries\\":128,\\"list-max-ziplist-entries\\":512,\\"list-max-ziplist-value\\":64,\\"zset-max-ziplist-value\\":64,\\"set-max-intset-entries\\":512,\\"hash-max-ziplist-value\\":64}', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '12123216-4B00-4378-BE4B-08005BFC****', 'title' => ''], 'Bandwidth' => ['description' => 'The maximum bandwidth in MB/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '96', 'title' => ''], 'Connections' => ['description' => 'The maximum number of connections.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], 'InstanceName' => ['description' => 'The instance name.'."\n" ."\n" .'> This parameter is returned only when the **InstanceName** parameter is specified in the request.', 'type' => 'string', 'example' => 'redistest', 'title' => ''], 'ZoneId' => ['description' => 'The availability zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], 'InstanceStatus' => ['description' => 'The instance status. The value is always **Creating**.', 'type' => 'string', 'example' => 'Creating', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '10****', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2084452111111', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', 'description' => ''], ['errorCode' => 'InvalidToken.Malformed', 'errorMessage' => 'The Specified parameter Token is not valid.', 'description' => ''], ['errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter InstanceName is not valid.', 'description' => ''], ['errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The Specified parameter Password is not valid.', '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' => 'PaymentMethodNotFound', 'errorMessage' => 'No payment method has been registered on the account.', 'description' => ''], ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Request uses a client token in a previous request but is not identical to that request.', 'description' => 'Idempotent check.'], ['errorCode' => 'QuotaNotEnough', 'errorMessage' => 'Quota not enough in this zone.', 'description' => ''], ['errorCode' => 'QuotaExceed', 'errorMessage' => 'Living afterpay instances quota exceed.', 'description' => ''], ['errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke vpc service failed.', 'description' => ''], ['errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify iz not support vpc.', 'description' => ''], ['errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The vpc does not cover the vswitch.', 'description' => ''], ['errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'The Specified vpc zone not supported.', 'description' => ''], ['errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', 'description' => ''], ['errorCode' => 'InstanceClass.NotMatch', 'errorMessage' => 'Current instance class and instance type is not match.', 'description' => ''], ['errorCode' => 'InvalidVPCId.NotFound', 'errorMessage' => 'Specified virtual vpc is not found.', 'description' => 'The specified VPC is not found. Check whether the VPC ID is correct.'], ['errorCode' => 'AccountMoneyValidateError', 'errorMessage' => 'Account money validate error.', 'description' => ''], ['errorCode' => 'RequestTokenConflict', 'errorMessage' => 'Specified request token conflict.', 'description' => ''], ['errorCode' => 'InvalidIPNotInSubnet', 'errorMessage' => 'Error ip not in subnet.', 'description' => ''], ['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', 'description' => 'The error message returned because the instance engine version is invalid.'], ['errorCode' => 'Zone.Closed', 'errorMessage' => 'The specified zone is closed.', 'description' => ''], ['errorCode' => 'VSwithNotBelongToNotVpcFault', 'errorMessage' => 'The vSwitch does not belong to current vpc.', 'description' => ''], ['errorCode' => 'PayIllegalAgreement', 'errorMessage' => 'Pay mayi with holding agreement illegal.', 'description' => ''], ['errorCode' => 'IllegalParamError', 'errorMessage' => 'validateSaleConditionWithSubArticle failed.', 'description' => ''], ['errorCode' => 'CASH_BOOK_INSUFFICIENT', 'errorMessage' => 'No payment method is specified for your account. We recommend that you add a payment method or maitain a minimum prepayment balance of INR 1000.', 'description' => ''], ['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The specified region is invalid.'], ], 403 => [ ['errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'Your account has not passed the real-name authentication yet.', 'description' => ''], ['errorCode' => 'AuthorizationFailure', 'errorMessage' => 'The request processing has failed due to authorization failure.', 'description' => ''], ['errorCode' => 'TokenServiceError', 'errorMessage' => 'The specified token is duplicated, please change it.', 'description' => ''], ['errorCode' => 'UserCannotBuyNotInnerCommodity', 'errorMessage' => 'The user can not buy this commodity without alibaba group tag.', 'description' => ''], ], [ ['errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', 'description' => 'The specified storage specification does not exist.'], ['errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The Specified vSwitchId zone not supported.', 'description' => ''], ['errorCode' => 'InvalidVpcIdOrVswitchId.NotSupported', 'errorMessage' => 'The Specified vpcId or vSwitchId not supported.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"QPS\\": 100000,\\n \\"ConnectionDomain\\": \\"r-bp13ac3d047b****.tairpena.rds.aliyuncs.com\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"InstanceId\\": \\"r-bp13ac3d047b****\\",\\n \\"Port\\": 6379,\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"EvictionPolicy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"volatile-lru\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hash-max-ziplist-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"zset-max-ziplist-entries\\\\\\\\\\\\\\":128,\\\\\\\\\\\\\\"list-max-ziplist-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"list-max-ziplist-value\\\\\\\\\\\\\\":64,\\\\\\\\\\\\\\"zset-max-ziplist-value\\\\\\\\\\\\\\":64,\\\\\\\\\\\\\\"set-max-intset-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"hash-max-ziplist-value\\\\\\\\\\\\\\":64}\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"12123216-4B00-4378-BE4B-08005BFC****\\",\\n \\"Bandwidth\\": 96,\\n \\"Connections\\": 10000,\\n \\"InstanceName\\": \\"redistest\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"InstanceStatus\\": \\"Creating\\",\\n \\"TaskId\\": \\"10****\\",\\n \\"OrderId\\": 2084452111111\\n}","type":"json"}]', 'title' => 'Create a Tair (Enterprise Edition) instance ', 'description' => 'For information about instance selection, see [ApsaraDB for Tair (Redis-compatible) instance selection guide](~~223808~~).'."\n" ."\n" .'Before you call this API, ensure you understand the billing methods and [pricing](~~54532~~) for ApsaraDB for Tair (Redis-compatible).'."\n" ."\n" .'> - To create an instance in the console, see [Create a Tair instance](~~26351~~).'."\n" .'>'."\n" .'> - To create other instance types, such as open-source or [Tair memory-enhanced](~~126164~~) classic edition, call the [CreateInstance](~~473757~~) API.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2026-03-04T14:05:32.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-09-08T13:19:35.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-14T08:04:47.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-02-27T06:33:26.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-11-20T01:48:52.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-10-09T03:20:54.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-07-30T05:39:11.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-05-23T02:14:08.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-04-26T07:23:45.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-29T03:36:55.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-12T06:13:47.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-03T02:23:17.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-12-22T03:11:26.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-25T07:29:26.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-29T01:51:32.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-21T09:05:25.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-21T07:46:42.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-03T08:17:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-01-10T03:25:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-11-14T08:14:21.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-27T12:03:36.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-15T04:13:52.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-15T03:42:17.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTairInstance'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateTairInstance', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:InstanceClass', 'validationType' => 'always'], ['conditionKey' => 'kvstore:InstanceType'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/*'], ], ], ], ], ], 'CreateTairKVCacheVNode' => [ 'summary' => 'Create a Tair VNode instance', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '265464', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where you want to create the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the zone where you want to create the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing-f', 'title' => ''], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The name of the new instance. The name must be 2 to 80 characters long and must start with a letter (case-insensitive) or a Chinese character. Spaces and the following special characters are not supported: `@/:=”<>{[]}`.', 'type' => 'string', 'required' => false, 'example' => 'vnodetest', 'title' => ''], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => ['description' => 'The instance specification.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'kvcache.cu.g4b.2'."\n", 'title' => ''], ], [ 'name' => 'ComputeUnitNum', 'in' => 'query', 'schema' => [ 'description' => 'The number of compute units. Currently, only one compute unit is supported.', 'enumValueTitles' => [1 => '1'], 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1', 'minimum' => '1', 'example' => '1', 'title' => '', ], ], [ 'name' => 'VkName', 'in' => 'query', 'schema' => ['description' => 'The ID of the virtual cluster that hosts the VNode.', 'type' => 'string', 'required' => true, 'example' => 'tk-2ze4bba3c8fe****'."\n", 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch for the instance. The vSwitch must belong to the VPC that is associated with the specified virtual cluster. You can call the [DescribeVpcs](~~35739~~) operation to obtain the vSwitch ID.'."\n" ."\n" .'> The vSwitch must be in the same zone as the instance.', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method for the instance. Valid value:'."\n" ."\n" .'- **PrePaid**: Subscription. If you specify this value, you must also specify the **Period** parameter.', 'enumValueTitles' => ['PrePaid' => 'PrePaid'], 'type' => 'string', 'required' => false, 'default' => 'PrePaid', 'enum' => ['PrePaid', 'PostPaid'], 'example' => 'PrePaid', 'title' => '', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The subscription period in months. Valid values: **1** to **9**, **12**, **24**, and **36**.'."\n" ."\n" .'> This parameter is required when the **ChargeType** parameter is set to **PrePaid**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => ['description' => 'Additional business information, such as a promotion ID.', 'type' => 'string', 'required' => false, 'example' => '000000000'."\n", 'title' => ''], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => ['description' => 'The coupon code.', 'type' => 'string', 'required' => false, 'default' => 'default', 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use a coupon. Valid values:'."\n" ."\n" .'- **true**: Use a coupon.'."\n" ."\n" .'- **false** (default): Do not use a coupon.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" ."\n" .'- **true**: Enables auto-renewal.'."\n" ."\n" .'- **false** (default): Disables auto-renewal.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => ['description' => 'The auto-renewal period, in months. Valid values: **1**, **2**, **3**, **6**, and **12**.'."\n" ."\n" .'> This parameter is required when the **AutoRenew** parameter is set to **true**.', 'type' => 'string', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group to which the instance will belong.'."\n" ."\n" .'> - You can call the [ListResourceGroups](~~158855~~) operation or view resource group IDs in the console. For more information, see [View the basic information about a resource group](~~151181~~).'."\n" .'>'."\n" .'> - Before changing the resource group of an instance, call the [ListResources](158866) API to view the current resource group of the instance.', 'type' => 'string', 'required' => false, 'maximum' => '4096', 'minimum' => '1', 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to automatically complete the payment. The value must be **true**.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'enum' => ['true'], 'example' => 'true', 'title' => '', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client-generated token that ensures request idempotence. This token must be unique across requests, is case-sensitive, and cannot exceed 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags to add to the instance. You can specify a maximum of five tags.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key.'."\n" ."\n" .'> You can specify up to 5 tag key-value pairs at a time.', 'type' => 'string', 'required' => false, 'example' => 'value1_test', 'title' => ''], 'Value' => ['description' => 'The tag value.'."\n" ."\n" .'> **N** represents the index of a tag, starting from 1. For example, **Tag.1.Value** is the value of the first tag.', 'type' => 'string', 'required' => false, 'example' => 'key1_test', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n" ."\n" .'- **true**: Performs a dry run and does not create the instance. The system checks the request parameters, request format, business limits, and available inventory. If the check fails, the system returns the corresponding error. If the check passes, the system returns the `DryRunOperation` error code.'."\n" ."\n" .'- **false** (default): Sends a normal request. If the check passes, the system creates the instance.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'VNodeType', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is no longer used.', 'type' => 'string', 'default' => 'fixed', 'enum' => ['fixed', 'elastic'], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'ElasticTimeRange', 'in' => 'query', 'schema' => ['description' => 'This parameter is no longer used.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID of the virtual node.', 'type' => 'string', 'example' => 'tv-2zeb1ce76fee****', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20905403119****', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-beijing-f', 'title' => ''], 'VkName' => ['description' => 'The instance ID of the virtual cluster.', 'type' => 'string', 'example' => 'tk-2ze4bba3c8fe****'."\n", 'title' => ''], 'VClusterId' => ['description' => 'The ID of the virtual cluster.', 'type' => 'string', 'example' => 'vc-16965a9267*****-*****', 'title' => ''], 'NodeId' => ['description' => 'The ID of the virtual node.', 'type' => 'string', 'example' => 'vn-03a49876edb****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', 'description' => ''], ['errorCode' => 'InvalidToken.Malformed', 'errorMessage' => 'The Specified parameter Token is not valid.', 'description' => ''], ['errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter InstanceName is not valid.', 'description' => ''], ['errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The Specified parameter Password is not valid.', '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' => 'PaymentMethodNotFound', 'errorMessage' => 'No payment method has been registered on the account.', 'description' => ''], ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Request uses a client token in a previous request but is not identical to that request.', 'description' => 'Idempotent check.'], ['errorCode' => 'QuotaNotEnough', 'errorMessage' => 'Quota not enough in this zone.', 'description' => ''], ['errorCode' => 'QuotaExceed', 'errorMessage' => 'Living afterpay instances quota exceed.', 'description' => ''], ['errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke vpc service failed.', 'description' => ''], ['errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify iz not support vpc.', 'description' => ''], ['errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The vpc does not cover the vswitch.', 'description' => ''], ['errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'The Specified vpc zone not supported.', 'description' => ''], ['errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', 'description' => ''], ['errorCode' => 'InstanceClass.NotMatch', 'errorMessage' => 'Current instance class and instance type is not match.', 'description' => ''], ['errorCode' => 'InvalidVPCId.NotFound', 'errorMessage' => 'Specified virtual vpc is not found.', 'description' => 'The specified VPC is not found. Check whether the VPC ID is correct.'], ['errorCode' => 'AccountMoneyValidateError', 'errorMessage' => 'Account money validate error.', 'description' => ''], ['errorCode' => 'RequestTokenConflict', 'errorMessage' => 'Specified request token conflict.', 'description' => ''], ['errorCode' => 'InvalidIPNotInSubnet', 'errorMessage' => 'Error ip not in subnet.', 'description' => ''], ['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', 'description' => 'The error message returned because the instance engine version is invalid.'], ['errorCode' => 'Zone.Closed', 'errorMessage' => 'The specified zone is closed.', 'description' => ''], ['errorCode' => 'VSwithNotBelongToNotVpcFault', 'errorMessage' => 'The vSwitch does not belong to current vpc.', 'description' => ''], ['errorCode' => 'PayIllegalAgreement', 'errorMessage' => 'Pay mayi with holding agreement illegal.', 'description' => ''], ['errorCode' => 'IllegalParamError', 'errorMessage' => 'validateSaleConditionWithSubArticle failed.', 'description' => ''], ['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The specified region is invalid.'], ], 403 => [ ['errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'Your account has not passed the real-name authentication yet.', 'description' => ''], ['errorCode' => 'AuthorizationFailure', 'errorMessage' => 'The request processing has failed due to authorization failure.', 'description' => ''], ['errorCode' => 'TokenServiceError', 'errorMessage' => 'The specified token is duplicated, please change it.', 'description' => ''], ['errorCode' => 'UserCannotBuyNotInnerCommodity', 'errorMessage' => 'The user can not buy this commodity without alibaba group tag.', 'description' => ''], ], [ ['errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', 'description' => 'The specified storage specification does not exist.'], ['errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The Specified vSwitchId zone not supported.', 'description' => ''], ['errorCode' => 'InvalidVpcIdOrVswitchId.NotSupported', 'errorMessage' => 'The Specified vpcId or vSwitchId not supported.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BE6E619-A657-42E3-AD2D-18F8428A****\\",\\n \\"InstanceId\\": \\"tv-2zeb1ce76fee****\\",\\n \\"OrderId\\": 0,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ZoneId\\": \\"cn-beijing-f\\",\\n \\"VkName\\": \\"tk-2ze4bba3c8fe****\\\\n\\",\\n \\"VClusterId\\": \\"vc-16965a9267*****-*****\\",\\n \\"NodeId\\": \\"vn-03a49876edb****\\"\\n}","type":"json"}]', 'title' => 'CreateTairKVCacheVNode', 'changeSet' => [ ['createdAt' => '2025-12-04T14:07:01.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTairKVCacheVNode'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateTairKVCacheVNode', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateTairSkvDdbTable' => [ 'summary' => 'Creates a Tair Serverless KV table instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the value is unique among different requests. The token is case-sensitive and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz**', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](https://help.aliyun.com/document_detail/61012.htm) to query available regions. Use this parameter to specify the region in which to create the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workspace instance. You can call [DescribeInstances](https://www.alibabacloud.com/help/en/redis/developer-reference/api-r-kvstore-2015-01-01-describeinstances-redis) to obtain the ID.', 'type' => 'string', 'required' => true, 'example' => 'tt-bp1zxszhcgatnx**', 'title' => ''], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => ['description' => 'The table name. The name must be 2 to 128 characters in length and must start with an uppercase letter, a lowercase letter, or a Chinese character. The name cannot contain the following characters: @/:="<>{}[] or spaces.', 'type' => 'string', 'required' => true, 'example' => 'apitest', 'title' => ''], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The instance type. Set the value to tair_skv_ddb_table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enum' => ['tair_skv_ddb_table'], 'example' => 'tair_skv_ddb_table', 'title' => '', ], ], [ 'name' => 'SrcDBInstanceId', 'in' => 'query', 'schema' => ['description' => 'To create an instance from a backup set of an existing instance, specify the ID of the source instance in this parameter.'."\n" ."\n" .'> This parameter must be used together with BackupId.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx**', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The cluster backup set ID. Some new cluster architectures support cluster backup set IDs. You can call [DescribeClusterBackupList](https://www.alibabacloud.com/help/en/redis/developer-reference/api-r-kvstore-2015-01-01-describeclusterbackuplist-redis) to obtain the ID.', 'type' => 'string', 'required' => false, 'example' => 'cb-hyxdof5x9kqb**', 'title' => ''], ], [ 'name' => 'Schema', 'in' => 'query', 'schema' => ['description' => 'The table schema configuration in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{"AttributeDefinitions":[{"AttributeType":"S","AttributeName":"pk"},{"AttributeType":"S","AttributeName":"sk"}],"KeySchema":[{"KeyType":"HASH","AttributeName":"pk"},{"KeyType":"RANGE","AttributeName":"sk"}]}', 'title' => ''], ], [ 'name' => 'TtlSpec', 'in' => 'query', 'schema' => ['description' => 'The parameter settings switch in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{"attributeName":"Expiretime","enabled":true}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'QPS' => ['description' => 'The queries per second (QPS). This value is the theoretical value for the current instance specification.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''], 'ConnectionDomain' => ['description' => 'The internal endpoint of the Redis instance.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx**.redis.rds.aliyuncs.com', 'title' => ''], 'ChargeType' => ['description' => 'The billing method. Valid values:'."\n" .'- PrePaid: subscription.'."\n" .'- PostPaid: pay-as-you-go.', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''], 'InstanceId' => ['description' => 'The globally unique instance ID.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx*', 'title' => ''], 'Port' => ['description' => 'The Redis service port.', 'type' => 'integer', 'format' => 'int32', 'example' => '6379', 'title' => ''], 'Config' => ['description' => 'The detailed configuration of the instance in JSON format. For more information about the parameters, see [Parameter settings](~~43885~~).', 'type' => 'string', 'example' => '{\\"EvictionPolicy\\":\\"volatile-lru\\",\\"hash-max-ziplist-entries\\":512,\\"zset-max-ziplist-entries\\":128,\\"zset-max-ziplist-value\\":64,\\"set-max-intset-entries\\":512,\\"hash-max-ziplist-value\\":64}', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2D9F3768-EDA9-4811-943E-42C8006E****', 'title' => ''], 'Bandwidth' => ['description' => 'The bandwidth limit of the instance. Unit: MB/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '96', 'title' => ''], 'Connections' => ['description' => 'The maximum number of connections supported by the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], 'TableName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'apitest', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID of the instance.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], 'InstanceStatus' => ['description' => 'The current status of the instance. The value is fixed to Creating.', 'type' => 'string', 'example' => 'Creating', 'title' => ''], 'TaskId' => ['description' => 'The ID of the task flow that is executed for the creation.', 'type' => 'string', 'example' => '11111****', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20741011111111', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', 'description' => ''], ['errorCode' => 'InvalidToken.Malformed', 'errorMessage' => 'The Specified parameter Token is not valid.', 'description' => ''], ['errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter InstanceName is not valid.', 'description' => ''], ['errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The Specified parameter Password is not valid.', 'description' => ''], ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Request uses a client token in a previous request but is not identical to that request.', 'description' => 'Idempotent check.'], ['errorCode' => 'QuotaNotEnough', 'errorMessage' => 'Quota not enough in this zone.', 'description' => ''], ['errorCode' => 'QuotaExceed', 'errorMessage' => 'Living afterpay instances quota exceed.', 'description' => ''], ['errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke vpc service failed.', 'description' => ''], ['errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify iz not support vpc.', 'description' => ''], ['errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The vpc does not cover the vswitch.', 'description' => ''], ['errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'The Specified vpc zone not supported.', 'description' => ''], ['errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', 'description' => ''], ['errorCode' => 'InstanceClass.NotMatch', 'errorMessage' => 'Current instance class and instance type is not match.', 'description' => ''], ['errorCode' => 'InvalidVPCId.NotFound', 'errorMessage' => 'Specified virtual vpc is not found.', 'description' => 'The specified VPC is not found. Check whether the VPC ID is correct.'], ['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', 'description' => 'The error message returned because the instance engine version is invalid.'], ['errorCode' => 'Zone.Closed', 'errorMessage' => 'The specified zone is closed.', 'description' => ''], ['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The specified region is invalid.'], ], 403 => [ ['errorCode' => 'AuthorizationFailure', 'errorMessage' => 'The request processing has failed due to authorization failure.', 'description' => ''], ['errorCode' => 'TokenServiceError', 'errorMessage' => 'The specified token is duplicated, please change it.', 'description' => ''], ], [ ['errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', 'description' => 'The specified storage specification does not exist.'], ['errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The Specified vSwitchId zone not supported.', 'description' => ''], ['errorCode' => 'InvalidVpcIdOrVswitchId.NotSupported', 'errorMessage' => 'The Specified vpcId or vSwitchId not supported.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create a tair serverless KV table instance', 'description' => '## Operation description'."\n" .'- Before you call this operation, make sure that you understand the billing methods and [pricing](https://help.aliyun.com/document_detail/54532.htm) of ApsaraDB for Redis.', 'requestParamsDescription' => 'https://r-kvstore.aliyuncs.com/?Action=CreateInstance'."\n" .'&RegionId=ap-southeast-1'."\n" .'&WorkspaceId=tt-2ze4mktt0xxxxxxxx'."\n" .'&InstanceType=tair_skv_ddb_table'."\n" .'&TableName=table1'."\n" .'&Schema={"AttributeDefinitions":[{"AttributeType":"S","AttributeName":"pk"},{"AttributeType":"S","AttributeName":"sk"}],"KeySchema":[{"KeyType":"HASH","AttributeName":"pk"},{"KeyType":"RANGE","AttributeName":"sk"}]}'."\n" .'&', 'responseParamsDescription' => '{'."\n" .' "Connections": 0,'."\n" .' "RequestId": "37B7A1E8-7590-1345-A0F2-EBD657D1AA8A",'."\n" .' "InstanceId": "tt-2zelkttksbyc12x6c",'."\n" .' "Port": 443,'."\n" .' "OrderId": 274427815940904,'."\n" .' "ConnectionDomain": "tt-2ze4mktt0jnguvf7m.tairskvddb.pre.rds.aliyuncs.com",'."\n" .' "TableName": "table1",'."\n" .' "QPS": 0,'."\n" .' "ChargeType": "PostPaid",'."\n" .' "InstanceStatus": "Creating",'."\n" .' "Bandwidth": 0,'."\n" .' "RegionId": "cn-beijing"'."\n" .'}', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateTairSkvDdbTable', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"QPS\\": 100000,\\n \\"ConnectionDomain\\": \\"r-bp1zxszhcgatnx**.redis.rds.aliyuncs.com\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx*\\",\\n \\"Port\\": 6379,\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"EvictionPolicy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"volatile-lru\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hash-max-ziplist-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"zset-max-ziplist-entries\\\\\\\\\\\\\\":128,\\\\\\\\\\\\\\"zset-max-ziplist-value\\\\\\\\\\\\\\":64,\\\\\\\\\\\\\\"set-max-intset-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"hash-max-ziplist-value\\\\\\\\\\\\\\":64}\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"2D9F3768-EDA9-4811-943E-42C8006E****\\",\\n \\"Bandwidth\\": 96,\\n \\"Connections\\": 10000,\\n \\"TableName\\": \\"apitest\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"InstanceStatus\\": \\"Creating\\",\\n \\"TaskId\\": \\"11111****\\",\\n \\"OrderId\\": 20741011111111\\n}","type":"json"}]', 'translator' => 'machine', ], 'CreateTairSkvDdbWorkspace' => [ 'summary' => 'Activates a Tair Serverless KV workspace instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the token is unique among different requests. The token is case-sensitive and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz**', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~473763~~) to query available regions. Use this parameter to specify the region in which to create the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID. You can call [DescribeZones](~~473764~~) to query available zones.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-e', 'title' => ''], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The instance type. Set the value to tair_skv_ddb_ws.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enum' => ['tair_skv_ddb_ws'], 'example' => 'tair_skv_ddb_ws', 'title' => '', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The instance name. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. The name cannot contain the following characters: @ / : = " < > { } or spaces.', 'type' => 'string', 'required' => false, 'example' => 'apitest', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['description' => 'The password of the instance. The password must meet the following requirements:'."\n" .'* The password is 8 to 32 characters in length.'."\n" .'* The password contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters are `!@#$%^&*()_+-=`.', 'type' => 'string', 'required' => false, 'example' => 'Pass!123456', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp1nme44gek34slfc**', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-bp1e7clcw529l773d**', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => ['description' => 'The service port of the instance. Valid values: 1 to 65535. Default value: 443.', 'type' => 'integer', 'format' => 'int32', 'default' => '443', 'required' => false, 'example' => '443', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'maximum' => '4096', 'minimum' => '1', 'example' => 'rg-resourcegroupid1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'QPS' => ['description' => 'The queries per second (QPS). This value is the theoretical value for the current instance specifications.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''], 'ConnectionDomain' => ['description' => 'The internal endpoint of the Redis instance.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx**.redis.rds.aliyuncs.com', 'title' => ''], 'ChargeType' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'* `PrePaid`: subscription.'."\n" .'* `PostPaid`: pay-as-you-go.', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''], 'InstanceId' => ['description' => 'The globally unique instance ID.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx**', 'title' => ''], 'Port' => ['description' => 'The Redis service port.', 'type' => 'integer', 'format' => 'int32', 'example' => '443', 'title' => ''], 'Config' => ['description' => 'The detailed configuration of the instance.', 'type' => 'string', 'example' => '{\\"EvictionPolicy\\":\\"volatile-lru\\",\\"hash-max-ziplist-entries\\":512,\\"zset-max-ziplist-entries\\":128,\\"zset-max-ziplist-value\\":64,\\"set-max-intset-entries\\":512,\\"hash-max-ziplist-value\\":64}', 'title' => ''], 'RegionId' => ['description' => 'The region in which the instance resides.', 'type' => 'string', 'example' => 'cn-hongkong', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5DEA3CC9-F81D-4387-8E97-CEA40F09****', 'title' => ''], 'Bandwidth' => ['description' => 'The bandwidth limit of the instance. Unit: MB/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '96', 'title' => ''], 'Connections' => ['description' => 'The maximum number of connections supported by the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'apitest', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID of the instance.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], 'InstanceStatus' => ['description' => 'The current status of the instance. The return value is fixed as Creating.', 'type' => 'string', 'example' => 'Creating', 'title' => ''], 'TaskId' => ['description' => 'The ID of the task flow that is executed for the creation.', 'type' => 'string', 'example' => '1111', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20741011111111', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', 'description' => ''], ['errorCode' => 'InvalidToken.Malformed', 'errorMessage' => 'The Specified parameter Token is not valid.', 'description' => ''], ['errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter InstanceName is not valid.', 'description' => ''], ['errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The Specified parameter Password is not valid.', 'description' => ''], ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Request uses a client token in a previous request but is not identical to that request.', 'description' => 'Idempotent check.'], ['errorCode' => 'QuotaNotEnough', 'errorMessage' => 'Quota not enough in this zone.', 'description' => ''], ['errorCode' => 'QuotaExceed', 'errorMessage' => 'Living afterpay instances quota exceed.', 'description' => ''], ['errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke vpc service failed.', 'description' => ''], ['errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify iz not support vpc.', 'description' => ''], ['errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The vpc does not cover the vswitch.', 'description' => ''], ['errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'The Specified vpc zone not supported.', 'description' => ''], ['errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', 'description' => ''], ['errorCode' => 'InstanceClass.NotMatch', 'errorMessage' => 'Current instance class and instance type is not match.', 'description' => ''], ['errorCode' => 'InvalidVPCId.NotFound', 'errorMessage' => 'Specified virtual vpc is not found.', 'description' => 'The specified VPC is not found. Check whether the VPC ID is correct.'], ['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', 'description' => 'The error message returned because the instance engine version is invalid.'], ['errorCode' => 'Zone.Closed', 'errorMessage' => 'The specified zone is closed.', 'description' => ''], ['errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', 'description' => 'The specified region is invalid.'], ], 403 => [ ['errorCode' => 'AuthorizationFailure', 'errorMessage' => 'The request processing has failed due to authorization failure.', 'description' => ''], ['errorCode' => 'TokenServiceError', 'errorMessage' => 'The specified token is duplicated, please change it.', 'description' => ''], ], [ ['errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', 'description' => 'The specified storage specification does not exist.'], ['errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The Specified vSwitchId zone not supported.', 'description' => ''], ['errorCode' => 'InvalidVpcIdOrVswitchId.NotSupported', 'errorMessage' => 'The Specified vpcId or vSwitchId not supported.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create a tair serverless KV workspace', 'description' => '## Operation description'."\n" .'- Before you call this operation, make sure that you understand the billing rules and [pricing](https://help.aliyun.com/document_detail/54532.htm) of ApsaraDB for Redis.'."\n" .'- To create a Tair Serverless KV table instance, call the `CreateTairSkvDdbTable` operation.', 'requestParamsDescription' => 'https://r-kvstore.aliyuncs.com/?Action=CreateInstance'."\n" .'&RegionId=ap-southeast-1'."\n" .'&ZoneId=ap-southeast-1e'."\n" .'&InstanceType=tair_skv_ddb_ws'."\n" .'&InstanceName=apitest'."\n" .'&', 'responseParamsDescription' => '{'."\n" .' "Connections": 0,'."\n" .' "RequestId": "3631EF6F-2979-1C04-BDAA-51XXXXXXXXX",'."\n" .' "InstanceId": "tt-2zesmjzrj0wzncb9y",'."\n" .' "Port": 443,'."\n" .' "OrderId": 0,'."\n" .' "ConnectionDomain": "tt-2zesmjzrj0wzncb9y.tairskvddb.pre.rds.aliyuncs.com",'."\n" .' "InstanceName": "apitest",'."\n" .' "QPS": 0,'."\n" .' "ChargeType": "PostPaid",'."\n" .' "InstanceStatus": "Normal",'."\n" .' "Bandwidth": 0,'."\n" .' "RegionId": "cn-beijing"'."\n" .'}', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateTairSkvDdbWorkspace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"QPS\\": 100000,\\n \\"ConnectionDomain\\": \\"r-bp1zxszhcgatnx**.redis.rds.aliyuncs.com\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx**\\",\\n \\"Port\\": 443,\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"EvictionPolicy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"volatile-lru\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hash-max-ziplist-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"zset-max-ziplist-entries\\\\\\\\\\\\\\":128,\\\\\\\\\\\\\\"zset-max-ziplist-value\\\\\\\\\\\\\\":64,\\\\\\\\\\\\\\"set-max-intset-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"hash-max-ziplist-value\\\\\\\\\\\\\\":64}\\",\\n \\"RegionId\\": \\"cn-hongkong\\",\\n \\"RequestId\\": \\"5DEA3CC9-F81D-4387-8E97-CEA40F09****\\",\\n \\"Bandwidth\\": 96,\\n \\"Connections\\": 10000,\\n \\"InstanceName\\": \\"apitest\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"InstanceStatus\\": \\"Creating\\",\\n \\"TaskId\\": \\"1111\\",\\n \\"OrderId\\": 20741011111111\\n}","type":"json"}]', ], 'DeleteAccount' => [ 'summary' => 'Deletes an account from a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '56365', 'abilityTreeNodes' => ['FEATUREkvstoreXSBQ72'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The username of the account. You can call the [DescribeAccounts](~~473816~~) operation to query the username of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'demoaccount', 'title' => ''], ], [ 'name' => 'SourceBiz', 'in' => 'query', 'schema' => ['description' => 'This parameter is used only for internal maintenance. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SDK', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8129F11A-D70B-43A6-9455-CE9EAA71****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAccountName.Format', 'errorMessage' => 'Specified AccountName is not valid.', 'description' => ''], ['errorCode' => 'InvalidEngineVersion.Format', 'errorMessage' => 'Current EngineVersion does not support operations.', 'description' => 'The operation is not supported while the instance runs this engine version.'], ], 403 => [ ['errorCode' => 'OperationDenied.AccountStatus', 'errorMessage' => 'The operation is not permitted due to status of account.', 'description' => 'This operation is not allowed due to the state of the account.'], ], [ ['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified AccountName does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8129F11A-D70B-43A6-9455-CE9EAA71****\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"8129F11A-D70B-43A6-9455-CE9EAA71F095\\"\\n}"},{"type":"xml","example":"\\n 8129F11A-D70B-43A6-9455-CE9EAA71****\\n","errorExample":"\\n 8129F11A-D70B-43A6-9455-CE9EAA71F095\\n"}]', 'title' => 'DeleteAccount', 'description' => '* This operation is supported only for instances that are compatible with Redis 4.0 or later.'."\n" .'* The instance must be in the Running state.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-07-11T12:25:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-02-26T09:46:19.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-03-02T02:42:53.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DeleteAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DeleteBackup' => [ 'summary' => 'Delete the specified backup set. Only manual backup sets can be deleted.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '269551', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The backup file ID of the instance. You can invoke [DescribeBackups](~~473823~~) to query it.', 'type' => 'string', 'required' => true, 'example' => '521****66', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F14475F4-644E-51EA-B1E8-E4D442093D0C'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F14475F4-644E-51EA-B1E8-E4D442093D0C\\"\\n}","type":"json"}]', 'title' => 'Delete Backup Set', 'description' => '* This operation supports only cloud-native instances.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackup'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DeleteBackup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteGlobalSecurityIPGroup' => [ 'summary' => 'Deletes a global IP whitelist template.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'GlobalIgName', 'in' => 'query', 'schema' => ['description' => 'The name of the global IP whitelist template. The name must meet the following requirements:'."\n" ."\n" .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" .'* The name must start with a letter and end with a letter or a digit.'."\n" .'* The name must be 2 to 120 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_123', 'title' => ''], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the IP whitelist template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'g-kd2iop4aur9qwxnvh***', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4e******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AD425AD3-CC7B-4EE2-A5CB-2F61BA73****'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Missing input parameter'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD425AD3-CC7B-4EE2-A5CB-2F61BA73****\\"\\n}","type":"json"}]', 'title' => 'DeleteGlobalSecurityIPGroup', 'description' => 'Before you delete an IP whitelist template, you must unbind (disassociate) the instances that are currently associated with the template.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGlobalSecurityIPGroup'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DeleteGlobalSecurityIPGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteInstance' => [ 'summary' => 'Releases a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56368', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW', 'FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance that you want to release.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'GlobalInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the distributed instance to which the instance belongs. This parameter is applicable to only China site (aliyun.com).'."\n", 'type' => 'string', 'required' => false, 'example' => 'gr-bp14rkqrhac****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D190D2', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'InstanceReleaseProtection', 'errorMessage' => 'The operation is not permitted due to instance release protection.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D190D2\\"\\n}","type":"json"}]', 'title' => 'DeleteInstance', 'description' => 'For more information about how to perform the corresponding operation in the console, see [Release an instance](~~43882~~).'."\n" ."\n" .'Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'* The instance is in the running state.'."\n" .'* The instance is charged on a pay-as-you-go basis.'."\n" ."\n" .'> You cannot call this operation to release a subscription instance, which is automatically released when it expires. To release a subscription instance before it expires, submit a ticket.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DeleteInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DeleteParameterGroup' => [ 'summary' => 'Deletes a parameter template.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '179016', 'abilityTreeNodes' => ['FEATUREkvstoreDVVZYL'], ], 'parameters' => [ [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the parameter template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'g-sysa00*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****'], 'ParamGroupId' => ['description' => 'The parameter template ID, which is globally unique.'."\n", 'type' => 'string', 'example' => 'rpg-sys-00*****', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BE6E619-A657-42E3-AD2D-18F8428A****\\",\\n \\"ParamGroupId\\": \\"rpg-sys-00*****\\"\\n}","type":"json"}]', 'title' => 'DeleteParameterGroup', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteParameterGroup'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DeleteParameterGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteShardingNode' => [ 'summary' => 'Removes one or more data shards from a Tair (Redis OSS-compatible) cluster instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '56369', 'abilityTreeNodes' => ['FEATUREkvstore6VEW31'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the data shard that you want to remove. You can specify multiple IDs at a time. Separate multiple IDs with commas (,).'."\n" ."\n" .'> If you specify both the NodeId and ShardCount parameters, the system prioritizes the NodeId parameter.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => false, 'example' => 'r-bp1zxszhcgatnx****-db-0,r-bp1zxszhcgatnx****-db-1', 'title' => ''], ], [ 'name' => 'ShardCount', 'in' => 'query', 'schema' => ['description' => 'The number of data shards that you want to remove. Shard removal starts from the end of the shard list.'."\n" ."\n" .'> For example, the instance has the following data shards: db-0, db-1, db-2, db-3, and db-4. In this case, if you set this parameter to 2, db-3 and db-4 are removed.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '4096', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'ForceTrans', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable forced transmission during a configuration change. Valid values:'."\n" ."\n" .'- **false** (default): Before the configuration change, the system checks the minor version of the instance. If the minor version of the instance is outdated, an error is reported. You must update the minor version of the instance and try again.'."\n" ."\n" .'- **true**: The system skips the version check and directly performs the configuration change.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want to delete the proxy nodes for instance in the proxy mode. Valid values:'."\n" ."\n" .'- **0 or Immediately** (default): immediately delete the proxy nodes.'."\n" ."\n" .'- **1 or MaintainTime**: delete the proxy nodes during the maintenance window.'."\n" ."\n" .'> You can call the [ModifyInstanceMaintainTime](~~473775~~) operation to modify the maintenance window of an instance.', 'type' => 'string', 'default' => '0', 'enum' => ['0', '1', 'Immediately', 'MaintainTime'], 'required' => false, 'example' => 'Immediately', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], 'OrderId' => ['description' => 'The ID of the order. On the Orders page in the Billing Management console, you can obtain the details of the order based on the order ID.', 'type' => 'string', 'example' => '22179******0904', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DeleteShardingNode', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-02-17T03:44:43.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-04T12:58:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-07-14T12:04:06.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-02-22T13:14:49.000Z', 'description' => 'Request parameters changed, Error codes changed'], ['createdAt' => '2022-02-22T13:14:49.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteShardingNode'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DeleteShardingNode', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\",\\n \\"OrderId\\": \\"22179******0904\\"\\n}","type":"json"}]', ], 'DescribeAccounts' => [ 'summary' => 'Queries information about a specific account in a specified ApsaraDB for Redis (Tair-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56373', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The name of the account that you want to query.', 'type' => 'string', 'required' => false, 'example' => 'demoaccount', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6C9E114C-217C-4118-83C0-B4070222****', 'title' => ''], 'Accounts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Account' => [ 'description' => 'The list of account information for the instance.', 'type' => 'array', 'items' => [ 'description' => 'The details of the account information.', 'type' => 'object', 'properties' => [ 'AccountDescription' => ['description' => 'The description of the account.', 'type' => 'string', 'example' => 'testdec', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'r-bp10noxlhcoim2****', 'title' => ''], 'AccountType' => ['description' => 'The type of the account. Valid values:'."\n" .'* **Normal**: standard account.'."\n" .'* **Super**: super account.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'AccountStatus' => ['description' => 'The status of the account. Valid values:'."\n" .'* **Unavailable**: The account is unavailable.'."\n" .'* **Available**: The account is available.', 'type' => 'string', 'example' => 'Available', 'title' => ''], 'AccountName' => ['description' => 'The name of the account.', 'type' => 'string', 'example' => 'demoaccount', 'title' => ''], 'DatabasePrivileges' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DatabasePrivilege' => [ 'description' => 'The list of account permissions.', 'type' => 'array', 'items' => [ 'description' => 'The details of the permissions that the account has.', 'type' => 'object', 'properties' => [ 'AccountPrivilege' => ['description' => 'The permissions of the account. Valid values:'."\n" .'* **RoleReadOnly**: read-only permissions.'."\n" .'* **RoleReadWrite**: read and write permissions. This is the default value.', 'type' => 'string', 'example' => 'RoleReadWrite', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Query Account Information', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-03-25T11:17:56.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccounts'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeAccounts', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C9E114C-217C-4118-83C0-B4070222****\\",\\n \\"Accounts\\": {\\n \\"Account\\": [\\n {\\n \\"AccountDescription\\": \\"testdec\\",\\n \\"InstanceId\\": \\"r-bp10noxlhcoim2****\\",\\n \\"AccountType\\": \\"Normal\\",\\n \\"AccountStatus\\": \\"Available\\",\\n \\"AccountName\\": \\"demoaccount\\",\\n \\"DatabasePrivileges\\": {\\n \\"DatabasePrivilege\\": [\\n {\\n \\"AccountPrivilege\\": \\"RoleReadWrite\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeActiveOperationMaintenanceConfig' => [ 'summary' => 'Queries the O\\\\\\&M task configurations of an instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HasConfig' => ['description' => 'Indicates whether the O\\&M task is configured. Valid values:'."\n" ."\n" .'* 1: The O\\&M task is configured.'."\n" .'* 0: The O\\&M task is not configured.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '794120D1-E0CF-4713-BAE4-EBAEA04506AF', 'title' => ''], 'Config' => [ 'description' => 'The configuration details of the O\\&M task.'."\n", 'type' => 'object', 'properties' => [ 'CycleType' => ['description' => 'The unit of the O\\&M task cycle. Valid values:'."\n" ."\n" .'* Month'."\n" .'* Week'."\n", 'type' => 'string', 'example' => 'Week', 'title' => ''], 'Status' => ['description' => 'Indicates whether the configurations take effect. Valid values:'."\n" ."\n" .'* 1: The configurations are in effect.'."\n" .'* 2: The configurations are invalid.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the last O\\&M task configurations are modified. The time follows the ISO 8601 standard in the *yyyy-mm-dd*T*hh:mm:ss*Z format. The time is displayed in Coordinated Universal Time (UTC).'."\n", 'type' => 'string', 'example' => '2024-05-30T14:30:00Z'."\n", 'title' => ''], 'MaintainStartTime' => ['description' => 'The start time of the O\\&M window. The time follows the ISO 8601 standard in the *hh:mm:ss* Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '18:00:00Z', 'title' => ''], 'MaintainEndTime' => ['description' => 'The end time of the O\\&M window. The time follows the ISO 8601 standard in the *hh:mm:ss* Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '20:00:00Z'."\n", 'title' => ''], 'CycleTime' => ['description' => 'The interval between two O\\&M tasks.'."\n" ."\n" .'* If the CycleType parameter is set to Month, the CycleTime parameter returns a string of numbers ranging from 1 to 28, which indicates the specific days of the month. The numbers are separated with commas (,). The CycleTime parameter returns 0 when the configurations do not take effect.'."\n" .'* If the CycleType parameter is set to Week, the CycleTime parameter returns a string of numbers ranging from 1 to 7, which indicates the specific days of the week. The numbers are separated with commas (,). The CycleTime parameter returns 0 when the configurations do not take effect.'."\n", 'type' => 'string', 'example' => '1,2,3', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the O\\&M task was created. The time follows the ISO 8601 standard in the *yyyy-mm-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-05-30T14:30:00Z'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HasConfig\\": 0,\\n \\"RequestId\\": \\"794120D1-E0CF-4713-BAE4-EBAEA04506AF\\",\\n \\"Config\\": {\\n \\"CycleType\\": \\"Week\\",\\n \\"Status\\": 1,\\n \\"ModifiedTime\\": \\"2024-05-30T14:30:00Z\\\\n\\",\\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 }\\n}","type":"json"}]', 'title' => 'DescribeActiveOperationMaintenanceConfig', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationMaintenanceConfig'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeActiveOperationMaintenanceConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeActiveOperationTask' => [ 'summary' => 'Queries the details of the O\\\\\\&M tasks of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56375', 'abilityTreeNodes' => ['FEATUREkvstoreAO067M'], ], 'parameters' => [ [ 'name' => 'Region', 'in' => 'query', 'schema' => ['description' => 'The region ID of the O&M task. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.'."\n" ."\n" .'> A value of **all** indicates all region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => ['description' => 'The type of the O\\&M task. Valid values:'."\n" ."\n" .'* **rds_apsaradb_ha**: master-replica switchover'."\n" .'* **rds_apsaradb_transfer**: instance migration'."\n" .'* **rds_apsaradb_upgrade**: minor version update'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds_apsaradb_ha', 'title' => ''], ], [ 'name' => 'IsHistory', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return the historical tasks. Default value: 0. Valid values:'."\n" ."\n" .'* **0**: returns the current task.'."\n" .'* **1**: returns the historical tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Specify a value greater than **10**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '30', 'default' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. The value must be an integer that is greater than **0**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2E1FF0CC-F42A-4B6F-A1F4-A17B1451****', 'title' => ''], 'PageSize' => ['description' => 'The maximum number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'description' => 'The list of O\\&M tasks.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The state of the O&M task. Valid values:'."\n" ."\n" .'* **2**: The task is waiting for users to specify a switchover time.'."\n" .'* **3**: The task is waiting to be performed.'."\n" .'* **4**: The task is being performed. If the task is in this state, the **ModifyActiveOperationTask** operation cannot be called to modify the scheduled switchover time.'."\n" .'* **5**: The task is performed.'."\n" .'* **6**: The task fails.'."\n" .'* **7**: The task is canceled.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'Deadline' => ['description' => 'The deadline before which the time to preform the O&M task can be modified. The time in UTC is displayed in the *yyyy-MM-dd*T*HH:mm:ss*Z format.', 'type' => 'string', 'example' => '2023-03-29T13:59:59Z', 'title' => ''], 'PrepareInterval' => ['description' => 'The required preparation period between the task start time and the switchover time. The time is displayed in the *HH:mm:ss* format.'."\n", 'type' => 'string', 'example' => '14:00:00', 'title' => ''], 'TaskType' => ['description' => 'The type of the task. Valid values:'."\n" ."\n" .'* **rds_apsaradb_ha**: master-replica switchover'."\n" .'* **rds_apsaradb_transfer**: instance migration'."\n" .'* **rds_apsaradb_upgrade**: minor version update'."\n" .'* **all**: all types'."\n", 'type' => 'string', 'example' => 'rds_apsaradb_upgrade', 'title' => ''], 'StartTime' => ['description' => 'The time when the O\\&M task was preformed. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-03-20T02:40:00Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the O\\&M task was modified. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-02-24T08:18:53Z', 'title' => ''], 'InsName' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1lgal1sdvxrz****', 'title' => ''], 'DbType' => ['description' => 'The database type of the instance. The return value is **Redis**.'."\n", 'type' => 'string', 'example' => 'redis', 'title' => ''], 'Region' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hanghzou', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the O\\&M task was created. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-02-24T06:00:11Z', 'title' => ''], 'Id' => ['description' => 'The ID of the O&M task.', 'type' => 'integer', 'format' => 'int32', 'example' => '1****1', 'title' => ''], 'SwitchTime' => ['description' => 'The time when the system performs the switchover operation. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-03-20T03:10:00Z', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Missing input parameter'], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"2E1FF0CC-F42A-4B6F-A1F4-A17B1451****\\",\\n \\"PageSize\\": 30,\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 5,\\n \\"Deadline\\": \\"2023-03-29T13:59:59Z\\",\\n \\"PrepareInterval\\": \\"14:00:00\\",\\n \\"TaskType\\": \\"rds_apsaradb_upgrade\\",\\n \\"StartTime\\": \\"2023-03-20T02:40:00Z\\",\\n \\"ModifiedTime\\": \\"2023-02-24T08:18:53Z\\",\\n \\"InsName\\": \\"r-bp1lgal1sdvxrz****\\",\\n \\"DbType\\": \\"redis\\",\\n \\"Region\\": \\"cn-hanghzou\\",\\n \\"CreatedTime\\": \\"2023-02-24T06:00:11Z\\",\\n \\"Id\\": 0,\\n \\"SwitchTime\\": \\"2023-03-20T03:10:00Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1\\r\\n 2E1FF0CC-F42A-4B6F-A1F4-A17B1451****\\r\\n 30\\r\\n 1\\r\\n \\r\\n 5\\r\\n 2019-10-17T20:28:31Z\\r\\n 2019-10-21T15:59:59Z\\r\\n 2019-10-17T17:50:00Z\\r\\n r-bp1lgal1sdvxrz****\\r\\n redis\\r\\n 2019-10-17T20:28:31Z\\r\\n rds_apsaradb_upgrade\\r\\n 01:00:00\\r\\n cn-hangzhou\\r\\n 114111\\r\\n 2019-10-17T18:50:00Z\\r\\n \\r\\n","errorExample":""}]', 'title' => 'DescribeActiveOperationTask', 'description' => 'After you have called this API operation and queried the information about a specific O&M task, you can also call the [ModifyActiveOperationTask](~~473864~~) operation to modify the scheduled switchover time of the O&M task.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTask'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeActiveOperationTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeActiveOperationTaskCount' => [ 'summary' => 'Queries the number of O\\\\\\&M tasks on a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'default' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TaskCount' => ['description' => 'The number of pending O\\&M tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'NeedPop' => ['description' => 'Indicates whether any O\\&M tasks need pop-up windows to notify users actions. Valid values:'."\n" ."\n" .'* **0**: No O\\&M tasks need pop-up windows to notify users actions.'."\n" .'* **1**: Some O\\&M tasks need pop-up windows to notify users actions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '2D9F3768-EDA9-4811-943E-42C8006E****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Missing input parameter'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskCount\\": 1,\\n \\"NeedPop\\": 0,\\n \\"RequestId\\": \\"2D9F3768-EDA9-4811-943E-42C8006E****\\"\\n}","type":"json"}]', 'title' => 'DescribeActiveOperationTaskCount', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTaskCount'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeActiveOperationTaskCount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeActiveOperationTasks' => [ 'summary' => 'Queries the O\\\\\\\\\\\\\\\\\\\\&M event details of an instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56378', 'abilityTreeNodes' => ['FEATUREkvstoreAO067M'], ], 'parameters' => [ [ 'name' => 'Region', 'in' => 'query', 'schema' => ['description' => 'The region ID of the O&M task. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.'."\n" ."\n" .'> A value of **all** indicates all region IDs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the O\\&M event. If this parameter is not specified, all types of O\\&M events are queried.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* rds_apsradb_upgrade: minor version update'."\n" .'* rds_apsaradb_ha: primary/secondary switchover'."\n" .'* rds_apsaradb_ssl_update: SSL certificate update'."\n" .'* rds_apsaradb_major_upgrade: major version upgrade'."\n" .'* rds_apsradb_transfer: instance migration'."\n" .'* rds_apsaradb_modify_config: network upgrade'."\n" .'* rds_apsaradb_modify_config: instance parameter adjustment'."\n" .'* rds_apsaradb_maxscale: proxy minor version update'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'enumValueTitles' => ['rds_apsradb_upgrade' => '', 'rds_apsaradb_ha' => '', 'rds_apsaradb_ssl_update' => '', 'rds_apsaradb_major_upgrade' => '', 'rds_apsradb_transfer' => '', 'rds_apsaradb_network_upgrade' => '', 'rds_apsaradb_modify_config' => '', 'rds_apsaradb_maxscale' => ''], 'example' => 'rds_apsradb_transfer', 'title' => '', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 25. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '25', 'default' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'ProductId', 'in' => 'query', 'schema' => ['description' => 'The name of the service. Valid values: RDS, POLARDB, MongoDB, and Redis. For Redis instances, set the value to Redis.', 'type' => 'string', 'required' => false, 'example' => 'Redis', 'title' => ''], ], [ 'name' => 'DbType', 'in' => 'query', 'schema' => ['description' => 'The database type. Valid values: **redis**', 'type' => 'string', 'required' => false, 'example' => 'redis', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The status of an O\\&M event. This parameter is used to filter returned tasks. Valid values:'."\n" ."\n" .'* **-1**: filters all events.'."\n" .'* **3**: filters pending events.'."\n" .'* **4**: filters in-progress events.'."\n" .'* **5**: filters successful events.'."\n" .'* **6**: filters failed events.'."\n" .'* **7**: filters canceled events.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'InsName', 'in' => 'query', 'schema' => ['description' => 'The name of the instance. You can leave this parameter empty. If you configure this parameter, you can specify the name only of one instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-wz96fzmpvpr2qnqnlb', 'title' => ''], ], [ 'name' => 'AllowChange', 'in' => 'query', 'schema' => ['description' => 'The filter condition that is used to return events based on the settings of the switching time. Default value: -1. Valid values:'."\n" ."\n" .'* **-1**: returns all events.'."\n" .'* **0**: returns only O\\&M events for which the switching time cannot be changed.'."\n" .'* **-1**: returns only O\\&M events for which the switching time can be changed.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '-1', 'title' => ''], ], [ 'name' => 'AllowCancel', 'in' => 'query', 'schema' => ['description' => 'The filter condition that is used to return events based on the settings of event cancellation. Default value: -1. Valid values:'."\n" ."\n" .'* **-1**: returns all events.'."\n" .'* **0**: returns only O\\&M events that cannot be canceled.'."\n" .'* **1**: returns only O\\&M events that can be canceled.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ChangeLevel', 'in' => 'query', 'schema' => ['description' => 'The type of task configuration change. Valid values:'."\n" ."\n" .'* **all** (default): The configurations of all O\\&M tasks are changed.'."\n" .'* **S0**: The configurations of tasks initiated to fix exceptions are changed.'."\n" .'* **S1**: The configurations of system O\\&M tasks are changed.'."\n", 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2D9F3768-EDA9-4811-943E-42C8006E****', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page. Default 25.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''], 'TotalRecordCount' => ['description' => 'The number of O\\&M events returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'description' => 'The list of O\\&M events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Details about the O\\&M event.'."\n", 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the O\\&M event. Valid values:'."\n" ."\n" .'* **3**: filters pending events.'."\n" .'* **4**: filters in-progress events.'."\n" .'* **5**: filters successful events.'."\n" .'* **6**: filters failed events.'."\n" .'* **7**: filters canceled events.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'ChangeLevelEn' => ['description' => 'The level of the task in English.'."\n", 'type' => 'string', 'example' => 'System maintenance'."\n", 'title' => ''], 'TaskType' => ['description' => 'The type of the O\\&M event.'."\n", 'type' => 'string', 'example' => 'rds_apsaradb_transfer', 'title' => ''], 'InsName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1lgal1sdvxrz****', 'title' => ''], 'Region' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hanghzou', 'title' => ''], 'ImpactZh' => ['description' => 'The impact of the task in Chinese.'."\n", 'type' => 'string', 'example' => '实例闪断'."\n", 'title' => ''], 'CreatedTime' => ['description' => 'The time when the O\\&M task was created. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-05-30T14:30:00Z'."\n", 'title' => ''], 'SwitchTime' => ['description' => 'The time when the system performs the switchover operation. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-05-30T14:30:00Z'."\n", 'title' => ''], 'ChangeLevelZh' => ['description' => 'The level of the task in Chinese.'."\n", 'type' => 'string', 'example' => '系统运维'."\n", 'title' => ''], 'Deadline' => ['description' => 'The deadline before which the time to preform the O&M task can be modified. The time in UTC is displayed in the *yyyy-MM-dd*T*HH:mm:ss*Z format.', 'type' => 'string', 'example' => '2018-05-30T23:59:59Z', 'title' => ''], 'PrepareInterval' => ['description' => 'The required preparation period between the task start time and the switchover time. The time is displayed in the *HH:mm:ss* format.'."\n", 'type' => 'string', 'example' => '04:00:00'."\n", 'title' => ''], 'TaskTypeZh' => ['description' => 'The reason for the task in Chinese.'."\n", 'type' => 'string', 'example' => '小版本升级'."\n", 'title' => ''], 'CurrentAVZ' => ['description' => 'The current zone.'."\n", 'type' => 'string', 'example' => 'cn-beijing-h'."\n", 'title' => ''], 'AllowChange' => ['description' => 'Indicates whether the switching time can be changed. The value 1 indicates that the switching time can be changed. The value 0 indicates that the switching time cannot be changed.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'DbVersion' => ['description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '5.0', 'title' => ''], 'ImpactEn' => ['description' => 'The impact of the task in English.'."\n", 'type' => 'string', 'example' => 'Transient instance disconnection', 'title' => ''], 'InsComment' => ['description' => 'The alias and description of the instance.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'StartTime' => ['description' => 'The time when the event is executed in the backend. The time must be in UTC. Format: YYYY-MM-DDTHH:mm:ssZ.'."\n", 'type' => 'string', 'example' => '2018-05-30T00:00:00Z'."\n", 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the O\\&M task was modified. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-05-30T14:30:00Z'."\n", 'title' => ''], 'AllowCancel' => ['description' => 'Indicates whether the event can be canceled. The value 1 indicates that the event can be canceled. The value 0 indicates that the event cannot be canceled.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'DbType' => ['description' => 'The database type of the instance. The return value is **Redis**.'."\n", 'type' => 'string', 'example' => 'redis', 'title' => ''], 'ChangeLevel' => ['description' => 'The code of the task level. The value S1 indicates the system O\\&M level. The value S0 indicates the exception fixing level.'."\n", 'type' => 'string', 'example' => 'S1', 'title' => ''], 'TaskTypeEn' => ['description' => 'The cause of the O\\&M event.'."\n", 'type' => 'string', 'example' => 'Minor version update', 'title' => ''], 'ResultInfo' => ['description' => 'The information about the execution result.'."\n", 'type' => 'string', 'example' => 'userCancel', 'title' => ''], 'Id' => ['description' => 'The ID of the O\\&M event.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11111', 'title' => ''], 'SubInsNames' => [ 'description' => 'The list of sub-events.'."\n", 'type' => 'array', 'items' => ['description' => 'The name of the sub-event.'."\n", 'type' => 'string', 'example' => 'sub1369716295573-tes2cy6****.2013052818****'."\n", 'title' => ''], 'title' => '', 'example' => '', ], 'TaskParams' => ['description' => 'The O\\&M event parameters.'."\n", 'type' => 'string', 'example' => '{'."\n" .' "Action": "UpgradeDBInstance"'."\n" .'}', 'title' => ''], 'Impact' => ['description' => 'The impact of the task.'."\n", 'type' => 'string', 'example' => 'TransientDisconnection', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"2D9F3768-EDA9-4811-943E-42C8006E****\\",\\n \\"PageSize\\": 25,\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": [\\n {\\n \\"Status\\": 5,\\n \\"ChangeLevelEn\\": \\"System maintenance\\\\n\\",\\n \\"TaskType\\": \\"rds_apsaradb_transfer\\",\\n \\"InsName\\": \\"r-bp1lgal1sdvxrz****\\",\\n \\"Region\\": \\"cn-hanghzou\\",\\n \\"ImpactZh\\": \\"实例闪断\\\\n\\",\\n \\"CreatedTime\\": \\"2018-05-30T14:30:00Z\\\\n\\",\\n \\"SwitchTime\\": \\"2018-05-30T14:30:00Z\\\\n\\",\\n \\"ChangeLevelZh\\": \\"系统运维\\\\n\\",\\n \\"Deadline\\": \\"2018-05-30T23:59:59Z\\",\\n \\"PrepareInterval\\": \\"04:00:00\\\\n\\",\\n \\"TaskTypeZh\\": \\"小版本升级\\\\n\\",\\n \\"CurrentAVZ\\": \\"cn-beijing-h\\\\n\\",\\n \\"AllowChange\\": \\"1\\",\\n \\"DbVersion\\": \\"5.0\\",\\n \\"ImpactEn\\": \\"Transient instance disconnection\\",\\n \\"InsComment\\": \\"test\\",\\n \\"StartTime\\": \\"2018-05-30T00:00:00Z\\\\n\\",\\n \\"ModifiedTime\\": \\"2018-05-30T14:30:00Z\\\\n\\",\\n \\"AllowCancel\\": \\"1\\",\\n \\"DbType\\": \\"redis\\",\\n \\"ChangeLevel\\": \\"S1\\",\\n \\"TaskTypeEn\\": \\"Minor version update\\",\\n \\"ResultInfo\\": \\"userCancel\\",\\n \\"Id\\": 11111,\\n \\"SubInsNames\\": [\\n \\"sub1369716295573-tes2cy6****.2013052818****\\\\n\\"\\n ],\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"Action\\\\\\": \\\\\\"UpgradeDBInstance\\\\\\"\\\\n}\\",\\n \\"Impact\\": \\"TransientDisconnection\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeActiveOperationTasks', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeAuditLogConfig' => [ 'summary' => 'Queries the audit log configurations of a Tair (Redis OSS-compatible) instance. The configurations include whether the audit log feature is enabled and the retention period of audit logs.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56380', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeInstanceAttribute](~~473779~~) operation to query the region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hanghzou', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Retention' => ['description' => 'The retention period of audit logs. Unit: days.'."\n", 'type' => 'string', 'example' => '5', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', 'title' => ''], 'DbAudit' => ['description' => 'Indicates whether the audit log feature is enabled. Valid values:'."\n" ."\n" .'* **true**: enabled'."\n" .'* **false**: disabled'."\n" ."\n" .'> You can call the [ModifyAuditLogConfig](~~473829~~) operation to enable or disable the audit log feature for a Tair (Redis OSS-compatible) instance.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The InstanceId provided does not exist in our records.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Retention\\": \\"5\\",\\n \\"RequestId\\": \\"2BE6E619-A657-42E3-AD2D-18F8428A****\\",\\n \\"DbAudit\\": \\"true\\"\\n}","type":"json"}]', 'title' => 'DescribeAuditLogConfig', 'description' => 'Before you call this operation, you must enable the audit log feature for the instance. For more information, see [ModifyAuditLogConfig](~~473829~~) or [Enable the audit log feature](~~102015~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-08-16T03:15:21.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAuditLogConfig'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeAuditLogConfig', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeAuditRecords' => [ 'summary' => 'Queries the audit logs of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56381', 'abilityTreeNodes' => ['FEATUREkvstoreE2TR4H'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the node in the instance. You can set this parameter to query the monitoring data of a specified node.'."\n" ."\n" .'> '."\n" ."\n" .'* This parameter is available only for read/write splitting and cluster instances.'."\n" ."\n" .'* You can call the [DescribeLogicInstanceTopology](~~473786~~) operation to query node IDs.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The username of the account. If you do not specify this parameter, all accounts of the instance are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'demo', 'title' => ''], ], [ 'name' => 'DatabaseName', 'in' => 'query', 'schema' => ['description' => 'The name of the database in the instance. If you do not specify this parameter, all databases are queried. Valid values: 0 to 255. 0 specifies database 0.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'QueryKeywords', 'in' => 'query', 'schema' => ['description' => 'The keyword based on which the audit logs are queried. You can specify a command as a keyword to query logs. By default, all commands are queried.'."\n" ."\n" .'> You can specify only a single keyword in each call.'."\n", 'type' => 'string', 'required' => false, 'example' => 'maxclients', 'title' => ''], ], [ 'name' => 'HostAddress', 'in' => 'query', 'schema' => ['description' => 'The IP address of the client. If you do not specify this parameter, this call applies to all clients.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', 'enum' => ['30', '50', '100'], 'title' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-03-24T12:10:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> We recommend that you specify a time range of 10 minutes or less because audit logs contain a great number of entries. Do not specify a time range that is longer than one day.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-03-25T12:10:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => 'The end time of the query.'."\n", 'type' => 'string', 'example' => '2019-03-25T12:10:00Z', 'title' => ''], 'StartTime' => ['description' => 'The start time of the query.'."\n", 'type' => 'string', 'example' => '2019-03-24T12:10:00Z', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9F5EB478-824E-4AC4-8D2B-58F31A02****', 'title' => ''], 'InstanceName' => ['description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22222', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The maximum number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SQL' => [ 'description' => 'The collection of returned audit log entries.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'HostAddress' => ['description' => 'The IP address of the client.'."\n", 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], 'SQLText' => ['description' => 'The command that was run.'."\n", 'type' => 'string', 'example' => 'CONFIG GET maxmemory', 'title' => ''], 'DatabaseName' => ['description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'demo', 'title' => ''], 'SQLType' => ['description' => 'The type of the command.'."\n", 'type' => 'string', 'example' => 'non_read_write', 'title' => ''], 'ExecuteTime' => ['description' => 'The time when the command was run.'."\n", 'type' => 'string', 'example' => '2019-03-25T03:22:08Z', 'title' => ''], 'TotalExecutionTimes' => ['description' => 'The amount of time consumed to run the command.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'NodeId' => ['description' => 'The ID of the node.'."\n" ."\n" .'> A specific node ID is returned only if the instance uses the cluster or read/write splitting architecture.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], 'AccountName' => ['description' => 'The username of the account.'."\n", 'type' => 'string', 'example' => 'demo', 'title' => ''], 'IPAddress' => ['description' => 'The IP address of the instance.'."\n", 'type' => 'string', 'example' => '192.16.100.***', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IncorrectDBInstance.NotSupported', 'errorMessage' => 'This instance do not support log audit.', 'description' => 'This instance does not support audit log related services'], ['errorCode' => 'InvalidEndTime.Invalid', 'errorMessage' => 'pecified end time is before this service active 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' => ''], ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => ''], ['errorCode' => 'InvalidPageNumbers.Malformed', 'errorMessage' => 'Specified page number is not valid.', 'description' => ''], ['errorCode' => 'InvalidQueryTime.Format', 'errorMessage' => 'Specified query time is not valid.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-03-25T12:10:00Z\\",\\n \\"StartTime\\": \\"2019-03-24T12:10:00Z\\",\\n \\"RequestId\\": \\"9F5EB478-824E-4AC4-8D2B-58F31A02****\\",\\n \\"InstanceName\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"TotalRecordCount\\": 22222,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Items\\": {\\n \\"SQL\\": [\\n {\\n \\"HostAddress\\": \\"127.0.0.1\\",\\n \\"SQLText\\": \\"CONFIG GET maxmemory\\",\\n \\"DatabaseName\\": \\"demo\\",\\n \\"SQLType\\": \\"non_read_write\\",\\n \\"ExecuteTime\\": \\"2019-03-25T03:22:08Z\\",\\n \\"TotalExecutionTimes\\": \\"0\\",\\n \\"NodeId\\": \\"r-bp1zxszhcgatnx****-db-0\\",\\n \\"AccountName\\": \\"demo\\",\\n \\"IPAddress\\": \\"192.16.100.***\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t127.0.0.1\\r\\n\\t\\t\\t2019-03-25T03:22:08Z\\r\\n\\t\\t\\tCONFIG GET band-width\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\tnon_read_write\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t127.0.0.1\\r\\n\\t\\t\\t2019-03-25T03:22:08Z\\r\\n\\t\\t\\tCONFIG GET maxmemory\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\tnon_read_write\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t127.0.0.1\\r\\n\\t\\t\\t2019-03-25T03:22:08Z\\r\\n\\t\\t\\tCONFIG GET maxclients\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\tnon_read_write\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t127.0.0.1\\r\\n\\t\\t\\t2019-03-25T03:22:08Z\\r\\n\\t\\t\\tCONFIG GET qps\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\tnon_read_write\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t127.0.0.1\\r\\n\\t\\t\\t2019-03-25T03:22:03Z\\r\\n\\t\\t\\tCONFIG GET qps\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\tnon_read_write\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t127.0.0.1\\r\\n\\t\\t\\t2019-03-25T03:22:03Z\\r\\n\\t\\t\\tCONFIG GET maxclients\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\tnon_read_write\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t127.0.0.1\\r\\n\\t\\t\\t2019-03-25T03:22:03Z\\r\\n\\t\\t\\tCONFIG GET maxmemory\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\tnon_read_write\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t36559\\r\\n\\t1\\r\\n\\t30\\r\\n\\t9F5EB478-824E-4AC4-8D2B-58F31A02****\\r\\n\\t2019-03-25T12:10:00Z\\r\\n\\t2019-03-24T12:10:00Z\\r\\n\\tr-bp1zxszhcgatnx****\\r\\n","errorExample":""}]', 'title' => 'DescribeAuditRecords', 'description' => 'Before you call this operation, you must enable the audit log feature for the instance. For more information, see [ModifyAuditLogConfig](~~473829~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAuditRecords'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeAuditRecords', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeAvailableResource' => [ 'summary' => 'Queries the types of Tair (Redis OSS-compatible) instances that can be created in a specified zone.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56382', 'abilityTreeNodes' => ['FEATUREkvstore9GDS4D'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID of the instance. You can call the [DescribeZones](~~473764~~) operation to query the most recent zone list.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou-h', 'title' => ''], ], [ 'name' => 'InstanceChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method. Valid values:'."\n" ."\n" .'* **PrePaid** (default): subscription'."\n" .'* **PostPaid**: pay-as-you-go'."\n", 'type' => 'string', 'required' => false, 'example' => 'PrePaid', 'default' => 'PrePaid', 'enum' => ['PrePaid', 'PostPaid'], 'title' => '', ], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => [ 'description' => 'The order type. Valid values:'."\n" ."\n" .'* **BUY** (default): orders that are used to create instances'."\n" .'* **UPGRADE**: orders that are used to upgrade instances'."\n" .'* **DOWNGRADE**: orders that are used to downgrade instances'."\n", 'type' => 'string', 'required' => false, 'example' => 'BUY', 'default' => 'BUY', 'enum' => ['BUY', 'UPGRADE', 'DOWNGRADE'], 'title' => '', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* **Redis**'."\n" .'* **Memcache**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Redis', 'enum' => ['Redis', 'Memcache', 'redis', 'memcache', 'REDIS', 'MEMCACHE'], 'title' => '', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group to which the instance belongs. You can call the [ListResourceGroups](~~158855~~) operation to query the IDs of resource groups.'."\n" ."\n" .'> You can also query the IDs of resource groups in the Resource Management console. For more information, see [View basic information about a resource group](~~151181~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4e******', 'default' => '', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n" ."\n" .'> This parameter is available and required only if the **OrderType** parameter is set to **UPGRADE** or **DOWNGRADE**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', 'schema' => ['description' => 'The display language of the response. Valid values:'."\n" ."\n" .'* **zh-CN**: Chinese. This is the default value.'."\n" .'* **en-US**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'default' => 'zh_CN', 'title' => ''], ], [ 'name' => 'ProductType', 'in' => 'query', 'schema' => ['description' => 'The instance type. Default value: Local. Valid values:'."\n" ."\n" .'* **Local**: classic Redis Open-Source Edition instance or classic DRAM-based instance'."\n" .'* **Tair_rdb**: cloud-native DRAM-based instance'."\n" .'* **Tair_scm**: persistent memory-optimized instance'."\n" .'* **Tair_essd**: ESSD/SSD-based instance'."\n" .'* **OnECS**: cloud-native Redis Open-Source Edition instance'."\n" ."\n" .'> The default value of this parameter is Local. To query disk resources, you must specify the instance type that provides the required disk resources.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Local', 'default' => 'Local', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the data node for which you want to query available resources that can be created. You can call the [DescribeLogicInstanceTopology](~~473786~~) operation to query the ID of the data node. Remove the number sign (`#`) and the content that follows the number sign. For example, retain only r-bp10noxlhcoim2\\*\\*\\*\\*-db-0.'."\n" ."\n" .'> Before you specify this parameter, you must set the **InstanceId** parameter to the ID of an instance that uses the cluster or read/write splitting architecture.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], ], [ 'name' => 'InstanceScene', 'in' => 'query', 'schema' => ['description' => 'The edition of the instance. Valid values:'."\n" ."\n" .'* **professional**: Standard Edition. This edition supports the standalone, master-replica, read /write splitting, and cluster architectures and provides high scalability.'."\n", 'type' => 'string', 'required' => false, 'example' => 'professional', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '493B7308-D9C2-55F6-B042-0313BD63****', 'title' => ''], 'AvailableZones' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AvailableZone' => [ 'description' => 'Details about the zones.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ZoneId' => ['description' => 'The ID of the zone in which the instance is located.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], 'ZoneName' => ['description' => 'The name of the zone.'."\n", 'type' => 'string', 'example' => '杭州 可用区H', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'SupportedEngines' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SupportedEngine' => [ 'description' => 'The supported engines.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Engine' => ['description' => 'The database engine of the instance.'."\n", 'type' => 'string', 'example' => 'Redis', 'title' => ''], 'SupportedEditionTypes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SupportedEditionType' => [ 'description' => 'The instance edition types.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EditionType' => ['description' => 'The edition of the instance. Valid values:'."\n" ."\n" .'* **Community**: Community Edition'."\n" .'* **Enterprise**: Enhanced Edition (Tair)'."\n", 'type' => 'string', 'example' => 'Enterprise', 'title' => ''], 'SupportedSeriesTypes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SupportedSeriesType' => [ 'description' => 'The instance series types.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SeriesType' => ['description' => 'The instance series. Valid values:'."\n" ."\n" .'* **enhanced_performance_type**: Tair (Enterprise Edition) DRAM-based instance'."\n" .'* **hybrid_storage**: Redis Open-Source Edition hybrid-storage instance', 'type' => 'string', 'example' => 'enhanced_performance_type', 'title' => ''], 'SupportedEngineVersions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SupportedEngineVersion' => [ 'description' => 'The available engine versions.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Version' => ['description' => 'The engine version of the instance.'."\n", 'type' => 'string', 'example' => '5.0', 'title' => ''], 'SupportedArchitectureTypes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SupportedArchitectureType' => [ 'description' => 'The available architectures.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Architecture' => ['description' => 'The architecture of the instance. Valid values:'."\n" ."\n" .'* **standard**: standard architecture'."\n" .'* **cluster**: cluster architecture'."\n" .'* **rwsplit**: read/write splitting architecture'."\n", 'type' => 'string', 'example' => 'cluster', 'title' => ''], 'SupportedShardNumbers' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SupportedShardNumber' => [ 'description' => 'The numbers of available shards.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ShardNumber' => ['description' => 'The number of shards.'."\n", 'type' => 'string', 'example' => '8', 'title' => ''], 'SupportedNodeTypes' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SupportedNodeType' => [ 'description' => 'The supported node types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The supported node type.'."\n", 'type' => 'object', 'properties' => [ 'SupportedNodeType' => ['description' => 'The node type of the instance. Valid values:'."\n" ."\n" .'* **single**: standalone'."\n" .'* **double**: master-replica'."\n", 'type' => 'string', 'example' => 'double', 'title' => ''], 'AvailableResources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AvailableResource' => [ 'description' => 'The available instance types.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The available instance type.'."\n", 'type' => 'object', 'properties' => [ 'InstanceClassRemark' => ['description' => 'The description of the instance type.'."\n", 'type' => 'string', 'example' => '16G集群版（8节点）（QPS:1920000 Connections:240000）', 'title' => ''], 'Capacity' => ['description' => 'The memory size of the instance. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16384', 'title' => ''], 'InstanceClass' => ['description' => 'The code of the instance type. If you want to view the code of an instance type, you can search for the code of the instance type in Help Center.'."\n", 'type' => 'string', 'example' => 'redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'IsMainSale' => ['description' => 'An internal parameter.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"493B7308-D9C2-55F6-B042-0313BD63****\\",\\n \\"AvailableZones\\": {\\n \\"AvailableZone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"ZoneName\\": \\"杭州 可用区H\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SupportedEngines\\": {\\n \\"SupportedEngine\\": [\\n {\\n \\"Engine\\": \\"Redis\\",\\n \\"SupportedEditionTypes\\": {\\n \\"SupportedEditionType\\": [\\n {\\n \\"EditionType\\": \\"Enterprise\\",\\n \\"SupportedSeriesTypes\\": {\\n \\"SupportedSeriesType\\": [\\n {\\n \\"SeriesType\\": \\"enhanced_performance_type\\",\\n \\"SupportedEngineVersions\\": {\\n \\"SupportedEngineVersion\\": [\\n {\\n \\"Version\\": \\"5.0\\",\\n \\"SupportedArchitectureTypes\\": {\\n \\"SupportedArchitectureType\\": [\\n {\\n \\"Architecture\\": \\"cluster\\",\\n \\"SupportedShardNumbers\\": {\\n \\"SupportedShardNumber\\": [\\n {\\n \\"ShardNumber\\": \\"8\\",\\n \\"SupportedNodeTypes\\": {\\n \\"SupportedNodeType\\": [\\n {\\n \\"SupportedNodeType\\": \\"double\\",\\n \\"AvailableResources\\": {\\n \\"AvailableResource\\": [\\n {\\n \\"InstanceClassRemark\\": \\"16G集群版（8节点）（QPS:1920000 Connections:240000）\\",\\n \\"Capacity\\": 16384,\\n \\"InstanceClass\\": \\"redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"IsMainSale\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"The region ID of the instance. You can call the [DescribeRegions](~~61012~~) operation to query the most recent region list.\\n","errorExample":""}]', 'title' => 'DescribeAvailableResource', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-02-18T06:22:39.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-25T12:05:29.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAvailableResource'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeAvailableResource', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeBackupPolicy' => [ 'summary' => 'Queries the backup policy of a Tair (Redis OSS-compatible) instance, including the backup cycle and backup time.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'BackupRetentionPeriod' => ['description' => 'The retention period of the backup data. Unit: days.'."\n", 'type' => 'string', 'example' => '7', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '90B82DB7-FB28-4CC2-ADBF-1F8659F3****', 'title' => ''], 'PreferredBackupPeriod' => ['description' => 'The backup cycle. Valid values:'."\n" ."\n" .'* **Monday**'."\n" .'* **Tuesday**'."\n" .'* **Wednesday**'."\n" .'* **Thursday**'."\n" .'* **Friday**'."\n" .'* **Saturday**'."\n" .'* **Sunday**'."\n", 'type' => 'string', 'example' => 'Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday', 'title' => ''], 'PreferredNextBackupTime' => ['description' => 'The next backup time. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-03-14T05:28Z', 'title' => ''], 'PreferredBackupTime' => ['description' => 'The time range during which the backup was created. The time follows the ISO 8601 standard in the *HH:mm*Z-*HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '05:00Z-06:00Z', 'title' => ''], 'EnableBackupLog' => ['description' => 'Indicates whether incremental data backup is enabled. Valid values:'."\n" ."\n" .'* **1**: Incremental data backup is enabled.'."\n" .'* **0**: Incremental data backup is disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'AccessDeniedDetail' => [ 'description' => 'The following parameters are no longer used. Ignore the parameters.'."\n", 'type' => 'object', 'properties' => [ 'AuthAction' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], 'AuthPrincipalDisplayName' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], 'AuthPrincipalOwnerId' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], 'AuthPrincipalType' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], 'EncodedDiagnosticMessage' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], 'NoPermissionType' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], 'PolicyType' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'DbsInstance' => ['description' => 'Indicates whether the backup-as-a-service feature is enabled for the instance. Valid values:'."\n" ."\n" .'* **1**: The backup-as-a-service feature is enabled for the instance.'."\n" .'* **0**: The backup-as-a-service feature is disabled for the instance.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupRetentionPeriod\\": \\"7\\",\\n \\"RequestId\\": \\"90B82DB7-FB28-4CC2-ADBF-1F8659F3****\\",\\n \\"PreferredBackupPeriod\\": \\"Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday\\",\\n \\"PreferredNextBackupTime\\": \\"2019-03-14T05:28Z\\",\\n \\"PreferredBackupTime\\": \\"05:00Z-06:00Z\\",\\n \\"EnableBackupLog\\": 1,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"-\\",\\n \\"AuthPrincipalDisplayName\\": \\"-\\",\\n \\"AuthPrincipalOwnerId\\": \\"-\\",\\n \\"AuthPrincipalType\\": \\"-\\",\\n \\"EncodedDiagnosticMessage\\": \\"-\\",\\n \\"NoPermissionType\\": \\"-\\",\\n \\"PolicyType\\": \\"-\\"\\n },\\n \\"DbsInstance\\": \\"0\\"\\n}","errorExample":"{\\n\\t\\"PreferredBackupPeriod\\": \\"Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday\\",\\n\\t\\"RequestId\\": \\"90B82DB7-FB28-4CC2-ADBF-1F8659F30C26\\",\\n\\t\\"PreferredNextBackupTime\\": \\"2018-10-26T19:05Z\\",\\n\\t\\"PreferredBackupTime\\": \\"19:00Z-20:00Z\\",\\n\\t\\"BackupRetentionPeriod\\": \\"7\\"\\n}"},{"type":"xml","example":"\\n Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday\\n 90B82DB7-FB28-4CC2-ADBF-1F8659F3****\\n 2018-10-26T19:05Z\\n 19:00Z-20:00Z\\n 7\\n","errorExample":"Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday\\n90B82DB7-FB28-4CC2-ADBF-1F8659F30C26\\n2018-10-26T19:05Z\\n19:00Z-20:00Z\\n7"}]', 'title' => 'DescribeBackupPolicy', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-13T03:44:14.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-11-06T03:07:19.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-08-31T06:36:23.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-25T11:33:07.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeBackupPolicy', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeBackupTasks' => [ 'summary' => 'Queries the execution status of backup tasks for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56386', 'abilityTreeNodes' => ['FEATUREkvstoreQ7TNCG'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. You can call the [DescribeInstances](~~473778~~) operation to query instance IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'BackupJobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup task.'."\n" ."\n" .'> If you call the [CreateBackup](~~473819~~) operation to perform a manual backup task, you can set this parameter to the returned backup ID to query the backup progress of the task.'."\n", 'type' => 'string', 'required' => false, 'example' => '1162****', 'pattern' => '^\\d+$', 'title' => ''], ], [ 'name' => 'JobMode', 'in' => 'query', 'schema' => [ 'description' => 'The backup mode. Valid values:'."\n" ."\n" .'* **Automated**: automatic backup. You can call the [DescribeBackupPolicy](~~473822~~) operation to query the automatic backup policy.'."\n" .'* **Manual**: manual backup.'."\n" ."\n" .'> By default, the information about backup tasks in both modes is returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Manual', 'enum' => ['Manual', 'Automated'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BB73740C-23E2-4392-9DA4-2660C74C****', 'title' => ''], 'BackupJobs' => [ 'description' => 'The details of the backup tasks.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'The start time of the backup task. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-01-05T19:24:00Z', 'title' => ''], 'Process' => ['description' => 'The progress of the backup task in percentage.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'JobMode' => ['description' => 'The backup mode. Valid values:'."\n" ."\n" .'* **Automated**: automatic backup'."\n" .'* **Manual**: manual backup'."\n", 'type' => 'string', 'example' => 'Manual', 'title' => ''], 'BackupJobID' => ['description' => 'The ID of the backup task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '29****10', 'title' => ''], 'BackupProgressStatus' => ['description' => 'The state of the backup task. Valid values:'."\n" ."\n" .'* **NoStart**: The backup task is not started.'."\n" .'* **Preparing**: The backup task is being prepared.'."\n" .'* **Waiting**: The backup task is pending.'."\n" .'* **Uploading**: The system is uploading the backup file.'."\n" .'* **Checking**: The system is checking the uploaded backup file.'."\n" .'* **Finished**: The backup task is completed.'."\n", 'type' => 'string', 'example' => 'NoStart', 'title' => ''], 'NodeId' => ['description' => 'The ID of the data node.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'TaskAction' => ['description' => 'The type of the backup task. Valid values:'."\n" ."\n" .'* **TempBackupTask**: The backup task was manually performed.'."\n" .'* **NormalBackupTask**: The backup task was automatically performed.'."\n", 'type' => 'string', 'example' => 'NormalBackupTask', 'title' => ''], 'Progress' => ['description' => 'The backup progress.'."\n", 'type' => 'string', 'example' => '27', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AccessDeniedDetail' => [ 'description' => 'The following parameters are no longer used. Ignore the parameters.'."\n", 'type' => 'object', 'properties' => [ 'AuthAction' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], 'AuthPrincipalDisplayName' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], 'AuthPrincipalOwnerId' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], 'AuthPrincipalType' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], 'EncodedDiagnosticMessage' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], 'NoPermissionType' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], 'PolicyType' => ['description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"RequestId\\": \\"BB73740C-23E2-4392-9DA4-2660C74C****\\",\\n \\"BackupJobs\\": [\\n {\\n \\"StartTime\\": \\"2021-01-05T19:24:00Z\\",\\n \\"Process\\": \\"0\\",\\n \\"JobMode\\": \\"Manual\\",\\n \\"BackupJobID\\": 0,\\n \\"BackupProgressStatus\\": \\"NoStart\\",\\n \\"NodeId\\": \\"****\\",\\n \\"TaskAction\\": \\"NormalBackupTask\\",\\n \\"Progress\\": \\"27\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"-\\",\\n \\"AuthPrincipalDisplayName\\": \\"-\\",\\n \\"AuthPrincipalOwnerId\\": \\"-\\",\\n \\"AuthPrincipalType\\": \\"-\\",\\n \\"EncodedDiagnosticMessage\\": \\"-\\",\\n \\"NoPermissionType\\": \\"-\\",\\n \\"PolicyType\\": \\"-\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n BB73740C-23E2-4392-9DA4-2660C74C****\\r\\n r-bp1zxszhcgatnx****\\r\\n \\r\\n Automated\\r\\n NormalBackupTask\\r\\n 2021-01-05T19:24:00Z\\r\\n NoStart\\r\\n 0\\r\\n 8491111\\r\\n \\r\\n","errorExample":""}]', 'title' => 'DescribeBackupTasks', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-01-15T06:27:27.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-03-26T02:50:30.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-11-13T03:44:14.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-11-06T03:20:17.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-25T11:33:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-12-16T04:05:04.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupTasks'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeBackupTasks', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeBackups' => [ 'summary' => 'Queries information about backup files for a Redis-compatible ApsaraDB for Tair instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56385', 'abilityTreeNodes' => ['FEATUREkvstore6TUUNS'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup file.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11611111', 'title' => ''], ], [ 'name' => 'BackupJobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup job returned by the `CreateBackup` operation. If `CreateBackup` returns multiple backup job IDs, call this operation for each ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of entries to return per page. Valid values: `30`, `50`, `100`, `200`, and `300`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'enum' => ['30', '50', '100', '200', '300', '1000'], 'example' => '30', 'title' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number to return. The value must be greater than **0**. The default value is **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time for the query. Specify the time in UTC using the *yyyy-MM-dd*T*HH:mm*Z format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-03-11T10:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time for the query. The end time must be later than the start time. Specify the time in UTC using the *yyyy-MM-dd*T*HH:mm*Z format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-03-14T18:00Z', 'title' => ''], ], [ 'name' => 'NeedAof', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable AOF persistence. Valid values:'."\n" ."\n" .'- **0**: Disabled.'."\n" ."\n" .'- **1**: Enabled.'."\n" ."\n" .'> The default value is **0**.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '963C20F0-7CE1-4591-AAF3-6F3CD1CE****', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'TotalCount' => ['description' => 'The total number of backup sets.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'FullStorageSize' => ['description' => 'The total size of full backups for the instance, in bytes. Full backups are generated from scheduled daily backups, manual backups, or cache analysis.'."\n" ."\n" .'> This value represents the total size of all valid full backups for the instance, regardless of the backup sets returned in this request.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'LogStorageSize' => ['description' => 'The total size of log backups for the instance, in bytes. This parameter is returned only if flashback is enabled.'."\n" ."\n" .'> This value represents the total size of all valid log backups for the instance, regardless of the backup sets returned in this request.', 'type' => 'integer', 'format' => 'int64', 'example' => '5000', 'title' => ''], 'FreeSize' => ['description' => 'The free backup quota for the instance, in bytes. The free quota is equal to the default memory size of the instance type. For more information, see [Changes to the free backup quota policy](~~2664017~~).'."\n" .'Full backups and log backups share this free quota. When the instance type is changed, the free quota also changes.'."\n" .'This parameter is not in effect. Ignore this parameter.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''], 'Backups' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Backup' => [ 'description' => 'An array of backup sets.', 'type' => 'array', 'items' => [ 'description' => 'The details of a backup set.', 'type' => 'object', 'properties' => [ 'BackupStatus' => ['description' => 'The backup status. Valid values:'."\n" ."\n" .'- **Success**: The backup was successful.'."\n" ."\n" .'- **Failed**: The backup failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'BackupStartTime' => ['description' => 'The start time of the backup.', 'type' => 'string', 'example' => '2019-03-14T05:28:50Z', 'title' => ''], 'BackupType' => ['description' => 'The backup type. Valid values:'."\n" ."\n" .'- **FullBackup**: A full backup.'."\n" ."\n" .'- **IncrementalBackup**: An incremental backup.', 'type' => 'string', 'example' => 'FullBackup', 'title' => ''], 'BackupDownloadURL' => ['description' => 'The public download URL of the backup set.', 'type' => 'string', 'example' => 'https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********', 'title' => ''], 'NodeInstanceId' => ['description' => 'The node ID.'."\n" ."\n" .'> For a Standard Edition instance, this parameter returns the instance ID.', 'type' => 'string', 'example' => 'r-bp10noxlhcoim2****-db-1', 'title' => ''], 'BackupEndTime' => ['description' => 'The completion time of the backup.', 'type' => 'string', 'example' => '2019-03-14T05:31:13Z', 'title' => ''], 'BackupId' => ['description' => 'The ID of the backup set.', 'type' => 'integer', 'format' => 'int64', 'example' => '165*****50', 'title' => ''], 'BackupDBNames' => ['description' => 'The backed-up databases. A value of **all** indicates that all databases were backed up.', 'type' => 'string', 'example' => 'all', 'title' => ''], 'EngineVersion' => ['description' => 'The engine version of the instance. It specifies the compatible Redis version.', 'type' => 'string', 'example' => '4.0', 'title' => ''], 'BackupIntranetDownloadURL' => ['description' => 'The internal download URL of the backup set.'."\n" ."\n" .'> You can use this URL to download the backup set from an ECS instance that is in the same VPC as the database instance.', 'type' => 'string', 'example' => 'https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********', 'title' => ''], 'BackupSize' => ['description' => 'The size of the backup set, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], 'BackupMode' => ['description' => 'The backup mode. Valid values:'."\n" ."\n" .'- **Automated**: An automated backup.'."\n" ."\n" .'- **Manual**: A manual backup.', 'type' => 'string', 'example' => 'Automated', 'title' => ''], 'BackupMethod' => ['description' => 'The backup method. Valid values:'."\n" ."\n" .'- **Logical**: A logical backup.'."\n" ."\n" .'- **Physical**: A physical backup.', 'type' => 'string', 'example' => 'Physical', 'title' => ''], 'BackupJobID' => ['description' => 'The ID of the backup job.', 'type' => 'integer', 'format' => 'int64', 'example' => '24340', 'title' => ''], 'RecoverConfigMode' => ['description' => 'Indicates whether the backup set includes configuration information such as accounts (`account`), kernel parameters (`config`), and allowlists (`whitelist`).'."\n" ."\n" .'> This parameter is available only for Cloud Native Edition instances. If you modify these settings, for example, create an account or add an IP address to an allowlist, the updated information is automatically included in subsequent backup sets.', 'type' => 'string', 'example' => '{"whitelist":true,"config":true,"account":true}', 'title' => ''], 'ExpectExpireTime' => ['description' => 'The expiration time of the backup set. The time is in UTC and uses the *yyyy-MM-dd*T*HH:mm:ss*Z format.', 'type' => 'string', 'example' => '2025-06-01T21:51:22Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => 'Details about the backup sets.', 'title' => '', 'example' => '', ], 'AccessDeniedDetail' => [ 'description' => 'This parameter is deprecated.', 'type' => 'object', 'properties' => [ 'AuthAction' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '-', 'title' => ''], 'AuthPrincipalDisplayName' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '-', 'title' => ''], 'AuthPrincipalOwnerId' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '-', 'title' => ''], 'AuthPrincipalType' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '-', 'title' => ''], 'EncodedDiagnosticMessage' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '-', 'title' => ''], 'NoPermissionType' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '-', 'title' => ''], 'PolicyType' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '-', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'description' => 'The response parameters.', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The Specified parameter StartTime is not valid.', 'description' => ''], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The Specified parameter EndTime is not valid.', 'description' => ''], ['errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'The Specified EngieVersion is not valid.', 'description' => ''], ['errorCode' => 'InvalidStartTimeAndEndTime.Malformed', 'errorMessage' => 'The end time must be greater than the start time.', 'description' => 'The end time must be later than the start time.'], ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963C20F0-7CE1-4591-AAF3-6F3CD1CE****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 5,\\n \\"FullStorageSize\\": 1000,\\n \\"LogStorageSize\\": 5000,\\n \\"FreeSize\\": 100000,\\n \\"Backups\\": {\\n \\"Backup\\": [\\n {\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupStartTime\\": \\"2019-03-14T05:28:50Z\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupDownloadURL\\": \\"https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********\\",\\n \\"NodeInstanceId\\": \\"r-bp10noxlhcoim2****-db-1\\",\\n \\"BackupEndTime\\": \\"2019-03-14T05:31:13Z\\",\\n \\"BackupId\\": 0,\\n \\"BackupDBNames\\": \\"all\\",\\n \\"EngineVersion\\": \\"4.0\\",\\n \\"BackupIntranetDownloadURL\\": \\"https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********\\",\\n \\"BackupSize\\": 1024,\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"BackupJobID\\": 24340,\\n \\"RecoverConfigMode\\": \\"{\\\\\\"whitelist\\\\\\":true,\\\\\\"config\\\\\\":true,\\\\\\"account\\\\\\":true}\\",\\n \\"ExpectExpireTime\\": \\"2025-06-01T21:51:22Z\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"-\\",\\n \\"AuthPrincipalDisplayName\\": \\"-\\",\\n \\"AuthPrincipalOwnerId\\": \\"-\\",\\n \\"AuthPrincipalType\\": \\"-\\",\\n \\"EncodedDiagnosticMessage\\": \\"-\\",\\n \\"NoPermissionType\\": \\"-\\",\\n \\"PolicyType\\": \\"-\\"\\n }\\n}","type":"json"}]', 'title' => 'View backup set list', 'description' => 'This operation does not apply to cloud-native cluster instances. Instead, use the [DescribeClusterBackupList](~~2679168~~) operation.', 'changeSet' => [ ['createdAt' => '2025-04-22T09:36:13.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-09-06T02:35:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-05-23T02:14:08.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-05-06T11:17:53.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-03-26T02:50:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-22T08:55:15.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-01-03T02:35:25.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-13T03:44:14.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-11-06T03:20:17.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-25T11:33:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-29T09:09:14.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackups'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeBackups', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeCacheAnalysisReport' => [ 'summary' => 'Queries the cache analysis report of an instance on a specified date.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56387', 'abilityTreeNodes' => ['FEATUREkvstoreIG5O17', 'FEATUREkvstoreUR6WYE'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Date', 'in' => 'query', 'schema' => ['description' => 'The date to query. You can query the report for one day each time. Specify the date in the *yyyy-MM-dd*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-08-05Z', 'title' => ''], ], [ 'name' => 'AnalysisType', 'in' => 'query', 'schema' => [ 'description' => 'The type of analytics. Set the value to **BigKey**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'BigKey', 'enum' => ['HotKey', 'BigKey'], 'title' => '', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **30**, **50**, and **100**.'."\n" ."\n" .'> The default value is **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', 'enum' => ['30', '50', '100'], 'title' => '', ], ], [ 'name' => 'PageNumbers', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return.'."\n" ."\n" .'> If the parameter value exceeds the maximum number of the returned pages, an empty large key list is returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the child node in the cluster instance.'."\n" ."\n" .'> If you do not specify this parameter, the analysis results of all child nodes in the instance are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The maximum number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A057C066-C3F5-4CC9-9FE4-A8D8B0DC****', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '160', 'title' => ''], 'BigKeys' => [ 'description' => 'Details of the large keys.'."\n", 'type' => 'array', 'items' => ['description' => 'The large key involved.'."\n", 'type' => 'object', 'example' => '[{"db": "0", "qps": 0, "keyType": "list", "isExpired": "no", "analysisType": "BIGKEY", "key": "mylist", "memory": 1005377, "size": 200000}]', 'title' => ''], 'title' => '', 'example' => '', ], 'HotKeys' => [ 'description' => 'Details of the hotkeys.'."\n" ."\n" .'> This parameter is not returned because Tair (Redis OSS-compatible) does not support hotkey analytics.', 'type' => 'array', 'items' => ['description' => 'The hot key involved.'."\n", 'type' => 'object', 'example' => '[]', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support this operation.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"RequestId\\": \\"A057C066-C3F5-4CC9-9FE4-A8D8B0DC****\\",\\n \\"PageRecordCount\\": 30,\\n \\"TotalRecordCount\\": 160,\\n \\"BigKeys\\": [\\n [\\n {\\n \\"db\\": \\"0\\",\\n \\"qps\\": 0,\\n \\"keyType\\": \\"list\\",\\n \\"isExpired\\": \\"no\\",\\n \\"analysisType\\": \\"BIGKEY\\",\\n \\"key\\": \\"mylist\\",\\n \\"memory\\": 1005377,\\n \\"size\\": 200000\\n }\\n ]\\n ],\\n \\"HotKeys\\": [\\n []\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1\\r\\n\\t160\\r\\n\\t30\\r\\n\\tA057C066-C3F5-4CC9-9FE4-A8D8B0DC****\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\tlist\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tmylist\\r\\n\\t\\t1005377\\r\\n\\t\\t200000\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:23124\\r\\n\\t\\t970\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:167541\\r\\n\\t\\t967\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:152015\\r\\n\\t\\t958\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:30883\\r\\n\\t\\t955\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:81031\\r\\n\\t\\t953\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:152007\\r\\n\\t\\t952\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:161880\\r\\n\\t\\t951\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:194610\\r\\n\\t\\t949\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:53620\\r\\n\\t\\t948\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:23525\\r\\n\\t\\t946\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:89333\\r\\n\\t\\t946\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:23687\\r\\n\\t\\t945\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:32653\\r\\n\\t\\t945\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:72166\\r\\n\\t\\t945\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:195881\\r\\n\\t\\t944\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:160121\\r\\n\\t\\t944\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:93626\\r\\n\\t\\t944\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:138451\\r\\n\\t\\t944\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:183732\\r\\n\\t\\t943\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:143393\\r\\n\\t\\t943\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:109289\\r\\n\\t\\t943\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:153637\\r\\n\\t\\t942\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:171049\\r\\n\\t\\t942\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:53013\\r\\n\\t\\t941\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:103664\\r\\n\\t\\t941\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:180733\\r\\n\\t\\t941\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:69766\\r\\n\\t\\t941\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:125910\\r\\n\\t\\t940\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\thash\\r\\n\\t\\tno\\r\\n\\t\\tBIGKEY\\r\\n\\t\\tcustomer:10653\\r\\n\\t\\t940\\r\\n\\t\\t11\\r\\n\\t\\r\\n\\t30\\r\\n","errorExample":""}]', 'title' => 'DescribeCacheAnalysisReport', 'description' => '> Tair (Redis OSS-compatible) has optimized the cache analytics feature to improve user experience. This API operation is phased out. You can use the new API operation for cache analytics. For more information, see [API operations for cache analytics are upgraded](~~186019~~).'."\n" ."\n" .'Before you call this operation, make sure that the instance meets the following requirements:'."\n" ."\n" .'* The engine version of the instance is Redis 4.0 or later.'."\n" .'* The instance uses the latest minor version. For more information about how to check whether to update the minor version of an instance, see [How do I check whether the minor version of a Tair (Redis OSS-compatible) instance is the latest?](~~129203~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCacheAnalysisReport'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeCacheAnalysisReport', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'dbinstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ], ], ], 'DescribeCacheAnalysisReportList' => [ 'summary' => 'Queries a list of cache analysis reports for an instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56388', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Days', 'in' => 'query', 'schema' => ['description' => 'The time range to query. Default value: 7. Unit: days.'."\n" ."\n" .'> If daily automatic analysis has not started and manual analysis is not performed, no records are returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **30**, **50**, and **100**.'."\n" ."\n" .'> The default value is **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', 'enum' => ['30', '50', '100'], 'title' => '', ], ], [ 'name' => 'PageNumbers', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the child node in the cluster instance.'."\n" ."\n" .'> If you do not specify this parameter, the analysis results of all child nodes in the instance are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => '1041xxxx', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '743D0A03-52DE-4E6F-8D09-EC1414CF****', 'title' => ''], 'DailyTasks' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DailyTask' => [ 'description' => 'The list of the offline key analysis reports.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Date' => ['description' => 'The date when the offline key analytics task was performed.'."\n", 'type' => 'string', 'example' => '2019-08-01Z', 'title' => ''], 'Tasks' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Task' => [ 'description' => 'Details about the offline key analysis reports.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Details about the offline key analysis report.'."\n", 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The state of the offline key analytics task. Valid values:'."\n" ."\n" .'* **success**'."\n" .'* **running**'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], 'StartTime' => ['description' => 'The start time of the offline key analytics task.'."\n", 'type' => 'string', 'example' => '2019-08-01T19:08:49Z', 'title' => ''], 'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '156465****', 'title' => ''], 'NodeId' => ['description' => 'The ID of the child node in the cluster instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support this operation.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"InstanceId\\": \\"1041xxxx\\",\\n \\"RequestId\\": \\"743D0A03-52DE-4E6F-8D09-EC1414CF****\\",\\n \\"DailyTasks\\": {\\n \\"DailyTask\\": [\\n {\\n \\"Date\\": \\"2019-08-01Z\\",\\n \\"Tasks\\": {\\n \\"Task\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"StartTime\\": \\"2019-08-01T19:08:49Z\\",\\n \\"TaskId\\": \\"156465****\\",\\n \\"NodeId\\": \\"r-bp1zxszhcgatnx****-db-0\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1041xxxx\\r\\n BFB9478A-119E-4589-B02C-2D2EBE5E****\\r\\n \\r\\n \\r\\n 2019-08-03Z\\r\\n \\r\\n \\r\\n success\\r\\n r-bp1zxszhcgatnx****-db-0\\r\\n 2019-08-03T19:08:48Z\\r\\n 156483****\\r\\n \\r\\n \\r\\n success\\r\\n r-bp1zxszhcgatnx****-db-1\\r\\n 2019-08-03T19:08:49Z\\r\\n 156483****\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n 2019-08-02Z\\r\\n \\r\\n \\r\\n success\\r\\n r-bp1zxszhcgatnx****-db-0\\r\\n 2019-08-02T19:08:55Z\\r\\n 156474****\\r\\n \\r\\n \\r\\n success\\r\\n r-bp1zxszhcgatnx****-db-1\\r\\n 2019-08-02T19:08:55Z\\r\\n 156474****\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n","errorExample":""}]', 'title' => 'DescribeCacheAnalysisReportList', 'description' => '> Tair (Redis OSS-compatible) has optimized the cache analytics feature to improve user experience. This API operation is phased out. You can use the new API operation for cache analytics. For more information, see [API operations for cache analytics are upgraded](~~186019~~).'."\n" ."\n" .'Before you call this operation, make sure that the instance meets the following requirements:'."\n" ."\n" .'* The engine version of the instance is Redis 4.0 or later.'."\n" .'* The instance uses the latest minor version. For more information about how to check whether to update the minor version of an instance, see [How do I check whether the minor version of a Tair (Redis OSS-compatible) instance is the latest?](~~129203~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCacheAnalysisReportList'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeCacheAnalysisReportList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeClusterBackupList' => [ 'summary' => 'Queries the backup list of a Tair (Redis OSS-compatible) cluster instance.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '187788', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-zhangjiakou', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-t4nj72oug5r5646qog', 'title' => ''], ], [ 'name' => 'ClusterBackupId', 'in' => 'query', 'schema' => ['description' => 'The backup set ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cb-hyxdof5x9kqbtust'."\n", 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* 30'."\n" .'* 50'."\n" .'* 100'."\n" .'* 200'."\n" .'* 300'."\n" .'* 5'."\n" .'* 10'."\n" .'* 15'."\n" .'* 20'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', 'enum' => ['30', '50', '100', '200', '300', '5', '10', '15', '20'], 'title' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2024-06-28T08:26Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2024-07-01T09:26Z', 'title' => ''], ], [ 'name' => 'NoShardBackup', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'Specifies whether to show backup set information for shards in the instance.'."\n" ."\n" .'* **true**: does not show backup set information for shards in the instance.'."\n" .'* **false** (default): shows backup set information for shards in the instance.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* True'."\n" .'* False'."\n", 'type' => 'string', 'required' => false, 'example' => 'True', 'enum' => ['True', 'False'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C009DA42-3B19-5B81-963D-1509DE2408DD'], 'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4'], 'PageNumber' => ['title' => '', 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['title' => '', 'description' => 'The maximum number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30'], 'FullStorageSize' => ['title' => '', 'description' => 'The size of the full backup file of the instance. Unit: bytes. Full backups originate from scheduled backups, manual backups, and backups generated during cache analysis.'."\n" ."\n" .'> The value of this parameter is independent of the number and size of returned backup sets. Instead, it represents the size of all valid full backups of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], 'LogStorageSize' => ['title' => '', 'description' => 'The size of the log backup file of the instance. Unit: bytes. This parameter is valid only when flashback is enabled.'."\n" ."\n" .'> The value of this parameter is independent of the number and size of returned backup sets. Instead, it represents the size of all valid log backups of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5000'], 'FreeSize' => ['title' => '', 'description' => 'This parameter does not take effect. Ignore this parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100000'], 'ClusterBackups' => [ 'title' => '', 'description' => 'The backup sets of the instance. A backup contains the backup sets of all shards in the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The backup set of the instance. A backup contains the backup sets of all shards in the instance.'."\n", 'type' => 'object', 'properties' => [ 'IsAvail' => ['title' => '', 'description' => 'Indicates whether the backup set is valid. A value of 0 indicates that shard-level backups failed or have not been completed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'ClusterBackupId' => ['title' => '', 'description' => 'The ID of the backup set.'."\n", 'type' => 'string', 'example' => 'cb-zmdqj2m3xyxjtdt0'], 'ClusterBackupStatus' => ['title' => '', 'description' => 'The status of the backup set.'."\n" ."\n" .'* OK'."\n" .'* RUNNING'."\n" .'* Failed'."\n", 'type' => 'string', 'example' => 'OK'], 'ClusterBackupSize' => ['title' => '', 'description' => 'The size of the backup set.'."\n", 'type' => 'string', 'example' => '2048'], 'ClusterBackupStartTime' => ['description' => 'The start time of the backup.'."\n", 'type' => 'string', 'example' => '2024-01-10T17:21:25Z', 'title' => ''], 'ClusterBackupEndTime' => ['description' => 'The end time of the backup.'."\n", 'type' => 'string', 'example' => '2024-01-10T17:21:55Z', 'title' => ''], 'ClusterBackupMode' => ['description' => 'The backup mode.'."\n", 'type' => 'string', 'example' => 'Automated', 'title' => ''], 'ShardClassMemory' => ['title' => '', 'description' => 'The memory size of a single shard during a full backup. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1024'], 'Backups' => [ 'title' => '', 'description' => 'The backup sets of all shards in the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The queried backup set.'."\n", 'type' => 'object', 'properties' => [ 'BackupId' => ['description' => 'The ID of the backup file.'."\n", 'type' => 'string', 'example' => '514645788', 'title' => ''], 'InstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'r-bp1y4is8svonly****-db-0', 'title' => ''], 'BackupDownloadURL' => ['description' => 'The public download URL of the backup file.'."\n", 'type' => 'string', 'example' => 'http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb', 'title' => ''], 'BackupIntranetDownloadURL' => ['description' => 'The internal download URL of the backup file.'."\n" ."\n" .'> You can use this URL to download the backup file from an Elastic Compute Service (ECS) instance that is connected to the Tair (Redis OSS-compatible) instance. The ECS instance must reside in the same virtual private cloud (VPC) as the Tair (Redis OSS-compatible) instance.'."\n", 'type' => 'string', 'example' => 'http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb', 'title' => ''], 'RecoverConfigMode' => ['description' => 'This parameter does not take effect. Ignore this parameter.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], 'BackupStartTime' => ['description' => 'The start time of the backup. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2024-01-09T17:21:30Z', 'title' => ''], 'BackupEndTime' => ['description' => 'The end time of the backup. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2024-01-09T17:21:57', 'title' => ''], 'BackupSize' => ['description' => 'The size of the backup file. Unit: bytes.'."\n", 'type' => 'string', 'example' => '1024', 'title' => ''], 'IsAvail' => ['description' => 'Indicates whether the backup set is available. Valid values:'."\n" ."\n" .'* **0**: unavailable'."\n" .'* **1**: available'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'BackupStatus' => ['description' => 'The status of the backup. Valid values:'."\n" ."\n" .'* **OK**'."\n" .'* **ERROR**'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], 'BackupName' => ['description' => 'The name of the backup.'."\n", 'type' => 'string', 'example' => 'hins100322105_data_20240110012135.rdb', 'title' => ''], 'Engine' => ['description' => 'The database engine. The return value is **redis**.'."\n", 'type' => 'string', 'example' => 'redis', 'title' => ''], 'ExtraInfo' => [ 'description' => 'The additional information.'."\n", 'type' => 'object', 'properties' => [ 'CustinsDbVersion' => ['description' => 'The engine version.'."\n", 'type' => 'string', 'example' => '5.0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Progress' => ['title' => '', 'description' => 'The backup progress. The system displays only the progress of running backup tasks.'."\n", 'type' => 'string', 'example' => '100%'], 'ExpectExpireTime' => ['description' => 'The time-to-live (TTL) of the backup set, in the format yyyy-MM-ddTHH:mmZ (UTC time). ', 'type' => 'string', 'example' => '2025-06-01T21:51:22Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C009DA42-3B19-5B81-963D-1509DE2408DD\\",\\n \\"MaxResults\\": 4,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"FullStorageSize\\": 1000,\\n \\"LogStorageSize\\": 5000,\\n \\"FreeSize\\": 100000,\\n \\"ClusterBackups\\": [\\n {\\n \\"IsAvail\\": 1,\\n \\"ClusterBackupId\\": \\"cb-zmdqj2m3xyxjtdt0\\",\\n \\"ClusterBackupStatus\\": \\"OK\\",\\n \\"ClusterBackupSize\\": \\"2048\\",\\n \\"ClusterBackupStartTime\\": \\"2024-01-10T17:21:25Z\\",\\n \\"ClusterBackupEndTime\\": \\"2024-01-10T17:21:55Z\\",\\n \\"ClusterBackupMode\\": \\"Automated\\",\\n \\"ShardClassMemory\\": 1024,\\n \\"Backups\\": [\\n {\\n \\"BackupId\\": \\"514645788\\",\\n \\"InstanceName\\": \\"r-bp1y4is8svonly****-db-0\\",\\n \\"BackupDownloadURL\\": \\"http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb\\",\\n \\"BackupIntranetDownloadURL\\": \\"http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb\\",\\n \\"RecoverConfigMode\\": \\"null\\",\\n \\"BackupStartTime\\": \\"2024-01-09T17:21:30Z\\",\\n \\"BackupEndTime\\": \\"2024-01-09T17:21:57\\",\\n \\"BackupSize\\": \\"1024\\",\\n \\"IsAvail\\": \\"1\\",\\n \\"BackupStatus\\": \\"OK\\",\\n \\"BackupName\\": \\"hins100322105_data_20240110012135.rdb\\",\\n \\"Engine\\": \\"redis\\",\\n \\"ExtraInfo\\": {\\n \\"CustinsDbVersion\\": \\"5.0\\"\\n }\\n }\\n ],\\n \\"Progress\\": \\"100%\\",\\n \\"ExpectExpireTime\\": \\"2025-06-01T21:51:22Z\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Query the backup list of a cluster instance ', 'description' => 'This API is applicable only to cloud-native instances.', 'changeSet' => [ ['createdAt' => '2025-04-22T09:36:13.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-01-15T06:27:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-27T09:29:10.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-05-23T02:14:08.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-21T07:15:23.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-22T08:55:15.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeClusterBackupList'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeClusterBackupList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeClusterMemberInfo' => [ 'summary' => 'Queries the configuration information of nodes in a Tair (Redis OSS-compatible) cluster instance, such as the specifications and the maximum number of connections.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56390', 'abilityTreeNodes' => ['FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Tair (Redis OSS-compatible) instance. You can call the [DescribeInstances](~~473778~~) operation to query instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **30**, **50**, and **100**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '30', 'default' => '30', 'enum' => ['30', '50', '100'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2D9F3768-EDA9-4811-943E-42C8006E****', 'title' => ''], 'ClusterChildren' => [ 'description' => 'Details about data nodes in the cluster instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Capacity' => ['description' => 'The maximum memory capacity per data node. Unit: MB.'."\n" ."\n" .'> This parameter is returned only if the return value of **Service** is **redis**, which indicates a data node.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], 'UserId' => ['description' => 'The ID of the user.'."\n", 'type' => 'string', 'example' => '2****_176498472570****', 'title' => ''], 'DiskSizeMB' => ['description' => 'The storage capacity of the [enhanced SSD (ESSD)](~~122389~~) that is used by the data node. Unit: MB.'."\n" ."\n" .'> The ESSD is used only to store system operating data, such as Persistent Memory (PMEM). It is not used as a medium to write and read data.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4096', 'title' => ''], 'BandWidth' => ['description' => 'The maximum bandwidth of the node. Unit: MB/s.'."\n" ."\n" .'> This parameter is returned only if the return value of **Service** is **redis**, which indicates a data node.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '96', 'title' => ''], 'CurrentBandWidth' => ['description' => 'The current bandwidth of the data node, which is the sum of the default bandwidth and any extra bandwidth that is purchased. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'ClassCode' => ['description' => 'The specifications of the data node. For more information, see [Community Edition instances that use cloud disks](~~164477~~).'."\n", 'type' => 'string', 'example' => 'redis.shard.small.ce', 'title' => ''], 'BizType' => ['description' => 'The type of workload. The return value is **ALIYUN**.'."\n", 'type' => 'string', 'example' => 'ALIYUN', 'title' => ''], 'Service' => ['description' => 'The node type. Valid values:'."\n" ."\n" .'* **redis**: data node'."\n" .'* **redis_cs**: config server'."\n", 'type' => 'string', 'example' => 'redis', 'title' => ''], 'BinlogRetentionDays' => ['description' => 'The retention period of binlogs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], 'Connections' => ['description' => 'The maximum number of connections supported by the data node.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20000', 'title' => ''], 'ResourceGroupName' => ['description' => 'The name of the resource group to which the node belongs.'."\n", 'type' => 'string', 'example' => 'GLOBAL_ZHANGJIAKOU_A', 'title' => ''], 'ServiceVersion' => ['description' => 'The major version of the node.'."\n", 'type' => 'string', 'example' => '5.0', 'title' => ''], 'ReplicaSize' => ['description' => 'The number of replica nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Name' => ['description' => 'The name of the data node.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], 'Id' => ['description' => 'The ID of the replica set in the node.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '501791111', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D9F3768-EDA9-4811-943E-42C8006E****\\",\\n \\"ClusterChildren\\": [\\n {\\n \\"Capacity\\": 1024,\\n \\"UserId\\": \\"2****_176498472570****\\",\\n \\"DiskSizeMB\\": 4096,\\n \\"BandWidth\\": 96,\\n \\"CurrentBandWidth\\": 100,\\n \\"ClassCode\\": \\"redis.shard.small.ce\\",\\n \\"BizType\\": \\"ALIYUN\\",\\n \\"Service\\": \\"redis\\",\\n \\"BinlogRetentionDays\\": 7,\\n \\"Connections\\": 20000,\\n \\"ResourceGroupName\\": \\"GLOBAL_ZHANGJIAKOU_A\\",\\n \\"ServiceVersion\\": \\"5.0\\",\\n \\"ReplicaSize\\": 0,\\n \\"Name\\": \\"r-bp1zxszhcgatnx****-db-0\\",\\n \\"Id\\": 501791111\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n D5362666-6A31-4DF6-99EB-93A74602****\\r\\n \\r\\n redis_cs\\r\\n ALIYUN\\r\\n 1024\\r\\n r-8vbktttx3r6izp****-cs-0\\r\\n 7\\r\\n redis.sharding.midce.cs.default\\r\\n 2****_176498472570****\\r\\n 5.0\\r\\n 501791111\\r\\n 0\\r\\n GLOBAL_ZHANGJIAKOU_A\\r\\n \\r\\n \\r\\n 20000\\r\\n redis\\r\\n ALIYUN\\r\\n 4096\\r\\n r-8vbktttx3r6izp****-db-1\\r\\n 7\\r\\n 96\\r\\n redis.shard.small.ce\\r\\n 1024\\r\\n 2****_176498472570****\\r\\n 5.0\\r\\n 501791111\\r\\n 0\\r\\n GLOBAL_ZHANGJIAKOU_A\\r\\n \\r\\n \\r\\n 20000\\r\\n redis\\r\\n ALIYUN\\r\\n 4096\\r\\n r-8vbktttx3r6izp****-db-2\\r\\n 7\\r\\n 96\\r\\n redis.shard.small.ce\\r\\n 1024\\r\\n 2****_176498472570****\\r\\n 5.0\\r\\n 501791111\\r\\n 0\\r\\n GLOBAL_ZHANGJIAKOU_A\\r\\n \\r\\n","errorExample":""}]', 'title' => 'DescribeClusterMemberInfo', 'description' => '> This API operation is applicable only to Tair (Redis OSS-compatible) instances that use [cloud disks](~~188068~~) and the [cluster architecture](~~52228~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-07-06T03:23:35.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-11-14T08:14:22.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeClusterMemberInfo'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeClusterMemberInfo', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeDBInstanceMonitor' => [ 'summary' => 'Queries the collection frequency of monitoring data for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56393', 'abilityTreeNodes' => ['FEATUREkvstoreW1V0SW'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1xp9esa45nll****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Interval' => ['description' => 'The collection frequency of the monitoring data. Unit: second.'."\n", 'type' => 'string', 'example' => '5', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '276F582D-C6B2-519C-A5ED-2A92BB15EC07', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeDBInstanceMonitor', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceMonitor'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeDBInstanceMonitor', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Interval\\": \\"5\\",\\n \\"RequestId\\": \\"276F582D-C6B2-519C-A5ED-2A92BB15EC07\\"\\n}","type":"json"}]', ], 'DescribeDBInstanceNetInfo' => [ 'summary' => 'Queries the network information of an ApsaraDB for Tair instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56394', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'NetType', 'in' => 'query', 'schema' => [ 'description' => 'The network type.', 'type' => 'string', 'enum' => ['Private', 'Public'], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceNetworkType' => ['description' => 'The network type. Valid values:'."\n" ."\n" .'- **CLASSIC**: Classic Network.'."\n" ."\n" .'- **VPC**: VPC.', 'type' => 'string', 'example' => 'CLASSIC', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B', 'title' => ''], 'NetInfoItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'InstanceNetInfo' => [ 'description' => 'An array of network connection details for the instance.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DirectConnection' => ['description' => 'Indicates whether the address is for a direct connection. Valid values:'."\n" ."\n" .'- **0**: The address is not for a direct connection.'."\n" ."\n" .'- **1**: The address is for a direct connection.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], 'DBInstanceNetType' => ['description' => 'The network type. Valid values:'."\n" ."\n" .'- **0**: public network.'."\n" ."\n" .'- **1**: Classic Network.'."\n" ."\n" .'- **2**: VPC network.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Upgradeable' => ['description' => 'The remaining validity period of the Classic Network connection string, in seconds.'."\n" ."\n" .'> A value of **0** indicates that the connection string does not expire.', 'type' => 'string', 'example' => '0', 'title' => ''], 'ExpiredTime' => ['description' => 'The validity period of the Classic Network connection string, in seconds.', 'type' => 'string', 'example' => '5183778', 'title' => ''], 'ConnectionString' => ['description' => 'The connection string of the instance.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', 'title' => ''], 'IPType' => ['description' => 'The network type of the IP address. Valid values:'."\n" ."\n" .'- **Public**: public network.'."\n" ."\n" .'- **Inner**: Classic Network.'."\n" ."\n" .'- **Private**: VPC network.', 'type' => 'string', 'example' => 'Inner', 'title' => ''], 'VPCInstanceId' => ['description' => 'The ID of the instance associated with the VPC.', 'type' => 'string', 'example' => 'r-bp1ky7j6qc7umk****', 'title' => ''], 'Port' => ['description' => 'The service port of the instance.', 'type' => 'string', 'example' => '6379', 'title' => ''], 'VPCId' => ['description' => 'The ID of the VPC to which the instance belongs.', 'type' => 'string', 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''], 'IPAddress' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '172.16.49.***', 'title' => ''], 'IsSlaveProxy' => ['description' => 'A value of 1 indicates that this network address is for a replica node in the standby zone.'."\n" ."\n" .'> This address is returned only when multi-zone read/write splitting is enabled for the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'description' => 'The details of a network connection.', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => 'Details about the instance\'s network connections.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceNetworkType\\": \\"CLASSIC\\",\\n \\"RequestId\\": \\"FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B\\",\\n \\"NetInfoItems\\": {\\n \\"InstanceNetInfo\\": [\\n {\\n \\"DirectConnection\\": 0,\\n \\"VSwitchId\\": \\"vsw-bp1e7clcw529l773d****\\",\\n \\"DBInstanceNetType\\": \\"1\\",\\n \\"Upgradeable\\": \\"0\\",\\n \\"ExpiredTime\\": \\"5183778\\",\\n \\"ConnectionString\\": \\"r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com\\",\\n \\"IPType\\": \\"Inner\\",\\n \\"VPCInstanceId\\": \\"r-bp1ky7j6qc7umk****\\",\\n \\"Port\\": \\"6379\\",\\n \\"VPCId\\": \\"vpc-bp1nme44gek34slfc****\\",\\n \\"IPAddress\\": \\"172.16.49.***\\",\\n \\"IsSlaveProxy\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeDBInstanceNetInfo', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-09-17T02:20:12.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-12-27T03:33:34.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-27T12:03:37.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceNetInfo'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeDBInstanceNetInfo', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeDBNodeDirectVipInfo' => [ 'summary' => 'Queries the information about virtual IP addresses (VIPs) of child instances of a cluster instance in direct connection mode.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '204017', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreZ21KYW', 'FEATUREkvstoreDER7E8', 'FEATUREkvstore4XSUU7'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABAF95F6-35C1-4177-AF3A-70969EBD****', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'DirectVipInfo' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'VipInfo' => [ 'description' => 'The VIP information of shards in the cluster instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The VIP information of a shard in the cluster instance.'."\n", 'type' => 'object', 'properties' => [ 'NodeId' => ['description' => 'The shard ID.'."\n", 'type' => 'string', 'example' => 'r-8vb3679b04551444-db-2', 'title' => ''], 'Vip' => ['description' => 'The VIP of the shard.'."\n", 'type' => 'string', 'example' => '100.115.61.8', 'title' => ''], 'Port' => ['description' => 'The port number. Valid values: **1024** to **65535**. Default value: **6379**.'."\n", 'type' => 'string', 'example' => '6379', 'title' => ''], 'NetType' => ['description' => 'The network type of the security group. Valid values:'."\n" ."\n" .'* **vpc**: Virtual Private Cloud (VPC)'."\n", 'type' => 'string', 'example' => 'vpc', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABAF95F6-35C1-4177-AF3A-70969EBD****\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"DirectVipInfo\\": {\\n \\"VipInfo\\": [\\n {\\n \\"NodeId\\": \\"r-8vb3679b04551444-db-2\\",\\n \\"Vip\\": \\"100.115.61.8\\",\\n \\"Port\\": \\"6379\\",\\n \\"NetType\\": \\"vpc\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeDBNodeDirectVipInfo', 'description' => '> Only instances that use cloud disks support this operation.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBNodeDirectVipInfo'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeDBNodeDirectVipInfo', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeDbInstanceConnectivity' => [ 'summary' => 'Checks the connectivity between the client IP address and the instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '160612', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1r36hdqlrgt1****', 'title' => ''], ], [ 'name' => 'SrcIp', 'in' => 'query', 'schema' => ['description' => 'The IP address of the client.'."\n", 'type' => 'string', 'required' => true, 'example' => '124.207.240.***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****'], 'ConnCheckResult' => ['description' => 'The connection check result. Valid values:'."\n" ."\n" .'* **Success**'."\n" .'* **Failed**'."\n", 'type' => 'string', 'example' => 'Failed', 'title' => ''], 'ConnCheckErrorCode' => ['description' => 'The error code for connection diagnosis. Valid values:'."\n" ."\n" .'* **SRC_IP_NOT_IN_USER_WHITELIST**: The source IP address is not added to the whitelist.'."\n" .'* **CONNECTION_ABNORMAL**: The connection to the instance is normal.'."\n", 'type' => 'string', 'example' => 'SRC_IP_NOT_IN_USER_WHITELIST', 'title' => ''], 'ConnCheckErrorMessage' => ['description' => 'The error message for connection diagnosis.'."\n", 'type' => 'string', 'example' => 'Src ip:172.28.134.96 not in user whitelist', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BE6E619-A657-42E3-AD2D-18F8428A****\\",\\n \\"ConnCheckResult\\": \\"Failed\\",\\n \\"ConnCheckErrorCode\\": \\"SRC_IP_NOT_IN_USER_WHITELIST\\",\\n \\"ConnCheckErrorMessage\\": \\"Src ip:172.28.134.96 not in user whitelist\\"\\n}","type":"json"}]', 'title' => 'DescribeDbInstanceConnectivity', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDbInstanceConnectivity'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeDbInstanceConnectivity', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeDedicatedClusterInstanceList' => [ 'summary' => 'Queries the information of Tair (Redis OSS-compatible) instances deployed in a dedicated cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56395', 'abilityTreeNodes' => ['FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID of the instance. You can call the [DescribeZones](~~473764~~) operation to query the most recent zone list.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-e', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n" ."\n" .'> The instance must be created by using a dedicated cluster. For more information, see [What is ApsaraDB for MyBase?](~~141455~~)'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'InstanceStatus', 'in' => 'query', 'schema' => ['description' => 'The state of the instance. Valid values:'."\n" ."\n" .'* **0**: The instance is being created.'."\n" .'* **1**: The instance is running.'."\n" .'* **3**: The instance is being deleted.'."\n" .'* **5**: The configurations of the instance are being changed.'."\n" .'* **6**: The instance is being migrated.'."\n" .'* **7**: The instance is being restored from a backup.'."\n" .'* **8**: A master-replica switchover is in progress.'."\n" .'* **9**: Expired data of the instance is being deleted.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceNetType', 'in' => 'query', 'schema' => ['description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **0**: Internet'."\n" .'* **1**: classic network'."\n" .'* **2**: Virtual Private Cloud (VPC)'."\n", 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Set the value to **Redis**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Redis', 'default' => 'Redis', 'enum' => ['Redis'], 'title' => '', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance. Set the value to **5.0**.'."\n", 'type' => 'string', 'required' => false, 'example' => '5.0', 'enum' => ['5.0', '6.0'], 'title' => '', ], ], [ 'name' => 'ClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the dedicated cluster. You can view the dedicated cluster ID on the Dedicated Clusters page in the ApsaraDB for MyBase console.'."\n" ."\n" .'> Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'dhg-5f2v98840ioq****', 'title' => ''], ], [ 'name' => 'DedicatedHostName', 'in' => 'query', 'schema' => ['description' => 'The ID of the host in the dedicated cluster. You can call the [DescribeDedicatedHosts](~~200944~~) operation to query the host ID.'."\n" ."\n" .'> Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'ch-t4n664a9mal4c****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. The value must be an integer that is greater than **0**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **30**, **50**, and **100**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'enum' => ['30', '50', '100'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '712CCF2A-16BD-411B-93F7-E978BEF2****', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Instances' => [ 'description' => 'Details about the instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Details about the instance.'."\n", 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-t4n2clc70t3hqwsrr****', 'title' => ''], 'CharacterType' => ['description' => 'The architecture of the instance. Valid values:'."\n" ."\n" .'* **logic**: cluster'."\n" .'* **normal**: standard'."\n", 'type' => 'string', 'example' => 'logic', 'title' => ''], 'VswitchId' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-t4nvrca24dczppq44****', 'title' => ''], 'InstanceClass' => ['description' => 'The instance type.'."\n", 'type' => 'string', 'example' => 'redis.cluster.sharding.common.ce', 'title' => ''], 'MaintainStartTime' => ['description' => 'The start time of the maintenance window. The time is in the *HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '16:00Z', 'title' => ''], 'CreateTime' => ['description' => 'The time when the instance was created. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2021-05-06T07:09:40Z', 'title' => ''], 'ConnectionDomain' => ['description' => 'The private endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com', 'title' => ''], 'MaintainEndTime' => ['description' => 'The end time of the maintenance window. The time is in the *HH:mm*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '17:00Z', 'title' => ''], 'StorageType' => ['description' => 'The storage type of the instance. The return value is LOCAL_SSD, which indicates [enhanced SSDs (ESSDs)](~~122389~~).'."\n", 'type' => 'string', 'example' => 'LOCAL_SSD', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1e7vl6ygf1yq****', 'title' => ''], 'BandWidth' => ['description' => 'The default bandwidth of the instance. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '24', 'title' => ''], 'CurrentBandWidth' => ['description' => 'The current bandwidth of the instance, which is the sum of the default bandwidth and any extra bandwidth that is purchased. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], 'EngineVersion' => ['description' => 'The database engine version of the instance. The return value is **5.0**.'."\n", 'type' => 'string', 'example' => '5.0', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'InstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'testdb', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-e', 'title' => ''], 'ClusterName' => ['description' => 'The name of the dedicated cluster to which the instance belongs.'."\n", 'type' => 'string', 'example' => 'testname', 'title' => ''], 'InstanceStatus' => ['description' => 'The state of the instance. Valid values:'."\n" ."\n" .'* **Normal**: The instance is normal.'."\n" .'* **Creating**: The instance is being created.'."\n" .'* **Changing**: The configurations of the instance are being changed.'."\n" .'* **Inactive**: The instance is disabled.'."\n" .'* **Flushing**: The instance is being released.'."\n" .'* **Released**: The instance is released.'."\n" .'* **Transforming**: The billing method of the instance is being changed.'."\n" .'* **Unavailable**: The instance is unavailable.'."\n" .'* **Error**: The instance failed to be created.'."\n" .'* **Migrating**: The instance is being migrated.'."\n" .'* **BackupRecovering**: The instance is being restored from a backup.'."\n" .'* **MinorVersionUpgrading**: The minor version of the instance is being updated.'."\n" .'* **NetworkModifying**: The network type of the instance is being changed.'."\n" .'* **SSLModifying**: The SSL configurations of the instance are being changed.'."\n" .'* **MajorVersionUpgrading**: The major version of the instance is being upgraded. The instance remains accessible during the upgrade.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'Engine' => ['description' => 'The database engine. The return value is **redis**.'."\n", 'type' => 'string', 'example' => 'redis', 'title' => ''], 'ShardCount' => ['description' => 'The number of shards.'."\n" ."\n" .'> This parameter is returned only when the instance is a [cluster](~~52228~~) instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'CustomId' => ['description' => 'An internal parameter used for the maintenance and management of instances.'."\n", 'type' => 'string', 'example' => '4652****', 'title' => ''], 'ProxyCount' => ['description' => 'The number of proxy nodes.'."\n" ."\n" .'> '."\n" ."\n" .'* If the return value is **0**, the proxy mode is disabled for the instance. If the return value is an integer greater than **0**, such as **1**, the proxy mode is enabled for the instance.'."\n" ."\n" .'* This parameter is returned only when the instance is a [cluster](~~52228~~) instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ClusterId' => ['description' => 'The ID of the dedicated cluster to which the instance belongs.'."\n", 'type' => 'string', 'example' => 'dhg-rx71fc5ndh9o****', 'title' => ''], 'InstanceNodeList' => [ 'description' => 'Details about the nodes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Details about the node.'."\n", 'type' => 'object', 'properties' => [ 'NodeIp' => ['description' => 'The IP address of the node.'."\n", 'type' => 'string', 'example' => '10.0.33.***', 'title' => ''], 'DedicatedHostName' => ['description' => 'The ID of the host in the dedicated cluster.'."\n", 'type' => 'string', 'example' => 'ch-bp13vf0y9gx3c****', 'title' => ''], 'NodeType' => ['description' => 'The node type. Valid values:'."\n" ."\n" .'* **db**: data node.'."\n" .'* **proxy**: proxy node.'."\n" .'* **normal**: regular node. This value is returned when the instance runs in the standard architecture.'."\n", 'type' => 'string', 'example' => 'normal', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID of the node.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1e7vl6ygf1yq****', 'title' => ''], 'Port' => ['description' => 'The port number that is used to connect to the node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3001', 'title' => ''], 'Role' => ['description' => 'The role of the node. Valid values:'."\n" ."\n" .'* **master**: master node'."\n" .'* **slave**: replica node'."\n", 'type' => 'string', 'example' => 'master', 'title' => ''], 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '17921111', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 25,\\n \\"RequestId\\": \\"712CCF2A-16BD-411B-93F7-E978BEF2****\\",\\n \\"TotalCount\\": 0,\\n \\"Instances\\": [\\n {\\n \\"VpcId\\": \\"vpc-t4n2clc70t3hqwsrr****\\",\\n \\"CharacterType\\": \\"logic\\",\\n \\"VswitchId\\": \\"vsw-t4nvrca24dczppq44****\\",\\n \\"InstanceClass\\": \\"redis.cluster.sharding.common.ce\\",\\n \\"MaintainStartTime\\": \\"16:00Z\\",\\n \\"CreateTime\\": \\"2021-05-06T07:09:40Z\\",\\n \\"ConnectionDomain\\": \\"r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com\\",\\n \\"MaintainEndTime\\": \\"17:00Z\\",\\n \\"StorageType\\": \\"LOCAL_SSD\\",\\n \\"InstanceId\\": \\"r-bp1e7vl6ygf1yq****\\",\\n \\"BandWidth\\": 24,\\n \\"CurrentBandWidth\\": 50,\\n \\"EngineVersion\\": \\"5.0\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceName\\": \\"testdb\\",\\n \\"ZoneId\\": \\"cn-hangzhou-e\\",\\n \\"ClusterName\\": \\"testname\\",\\n \\"InstanceStatus\\": \\"Normal\\",\\n \\"Engine\\": \\"redis\\",\\n \\"ShardCount\\": 3,\\n \\"CustomId\\": \\"4652****\\",\\n \\"ProxyCount\\": 1,\\n \\"ClusterId\\": \\"dhg-rx71fc5ndh9o****\\",\\n \\"InstanceNodeList\\": [\\n {\\n \\"NodeIp\\": \\"10.0.33.***\\",\\n \\"DedicatedHostName\\": \\"ch-bp13vf0y9gx3c****\\",\\n \\"NodeType\\": \\"normal\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"InstanceId\\": \\"r-bp1e7vl6ygf1yq****\\",\\n \\"Port\\": 3001,\\n \\"Role\\": \\"master\\",\\n \\"NodeId\\": 17921111\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n LOCAL_SSD\\n 5.0\\n cn-hangzhou-e\\n r-bp1e7vl6ygf1yq****\\n dhg-rx71fc5ndh9o****\\n 2021-05-06T07:09:40Z\\n redis.cluster.sharding.common.ce\\n logic\\n vsw-t4nvrca24dczppq44****\\n 50\\n 3\\n r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com\\n testdb\\n 24\\n 17:00Z\\n vpc-t4n2clc70t3hqwsrr****\\n Normal\\n 4652****\\n 1\\n testname\\n cn-hangzhou\\n redis\\n 16:00Z\\n \\n master\\n cn-hangzhou-h\\n ch-bp13vf0y9gx3c****\\n r-bp1e7vl6ygf1yq****\\n 3001\\n normal\\n 17921111\\n 10.0.33.***\\n \\n \\n 1\\n 712CCF2A-16BD-411B-93F7-E978BEF2****\\n 30\\n 1\\n","errorExample":""}]', 'title' => 'DescribeDedicatedClusterInstanceList', 'description' => '> If you want to query the information about Tair (Redis OSS-compatible) instances that are not deployed in a dedicated cluster, call the [DescribeInstanceAttribute](~~473779~~) operation.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-12-13T06:39:58.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDedicatedClusterInstanceList'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeDedicatedClusterInstanceList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeEncryptionKey' => [ 'summary' => 'Queries the details of a custom key for a Tair (Redis OSS-compatible) instance to use transparent data encryption (TDE).', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56397', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreDER7E8', 'FEATUREkvstore4XSUU7'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'EncryptionKey', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom key. You can call the [DescribeEncryptionKeyList](~~473860~~) operation to query the ID of the key.', 'type' => 'string', 'required' => false, 'example' => 'ad463061-992d-4195-8a94-ed63********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DeleteDate' => ['description' => 'The time when the custom key is expected to be deleted. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n" ."\n" .'> If the return value is an empty string, the custom key cannot be automatically deleted.'."\n", 'type' => 'string', 'example' => '2021-09-24T18:22:03Z', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9A931CE5-C926-5E09-B0EC-6299C4A6****', 'title' => ''], 'Description' => ['description' => 'The description of the custom key. By default, an empty string is returned.'."\n", 'type' => 'string', 'example' => 'testkey', 'title' => ''], 'Origin' => ['description' => 'The source of the custom key. A value of **Aliyun_KMS** indicates [Key Management Service (KMS)](~~28935~~) of Alibaba Cloud.'."\n", 'type' => 'string', 'example' => 'Aliyun_KMS', 'title' => ''], 'MaterialExpireTime' => ['description' => 'The time when the custom key expires. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n" ."\n" .'> If the return value is an empty string, the custom key does not expire.'."\n", 'type' => 'string', 'example' => '2021-09-24T18:22:03Z', 'title' => ''], 'EncryptionKeyStatus' => ['description' => 'The state of the custom key. Valid values:'."\n" ."\n" .'* **Enabled**: The custom key is available.'."\n" .'* **Disabled**: The custom key is unavailable.'."\n", 'type' => 'string', 'example' => 'Enabled', 'title' => ''], 'KeyUsage' => ['description' => 'The purpose of the custom key. A value of `ENCRYPT/DECRYPT` indicates encryption and decryption.'."\n", 'type' => 'string', 'example' => 'ENCRYPT/DECRYPT', 'title' => ''], 'EncryptionKey' => ['description' => 'The ID of the custom key.'."\n", 'type' => 'string', 'example' => 'ad463061-992d-4195-8a94-ed63********', 'title' => ''], 'Creator' => ['description' => 'The ID of the Alibaba Cloud account that is used to create the custom key.'."\n", 'type' => 'string', 'example' => '17649847********', 'title' => ''], 'EncryptionName' => ['description' => 'The encryption algorithm.'."\n", 'type' => 'string', 'example' => 'AES-CTR-256', 'title' => ''], 'RoleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role to which you want to grant permissions.'."\n", 'type' => 'string', 'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InstanceType.NotSupport', 'errorMessage' => 'Current instance type does not support this operation.', 'description' => 'The current instance type does not support this operation'], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeleteDate\\": \\"2021-09-24T18:22:03Z\\",\\n \\"RequestId\\": \\"9A931CE5-C926-5E09-B0EC-6299C4A6****\\",\\n \\"Description\\": \\"testkey\\",\\n \\"Origin\\": \\"Aliyun_KMS\\",\\n \\"MaterialExpireTime\\": \\"2021-09-24T18:22:03Z\\",\\n \\"EncryptionKeyStatus\\": \\"Enabled\\",\\n \\"KeyUsage\\": \\"ENCRYPT/DECRYPT\\",\\n \\"EncryptionKey\\": \\"ad463061-992d-4195-8a94-ed63********\\",\\n \\"Creator\\": \\"17649847********\\",\\n \\"EncryptionName\\": \\"AES-CTR-256\\",\\n \\"RoleArn\\": \\"acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Aliyun_KMS\\n testkey\\n Enabled\\n 9A931CE5-C926-5E09-B0EC-6299C4A6****\\n 2021-09-24T18:22:03Z\\n ENCRYPT/DECRYPT\\n ad463061-992d-4195-8a94-ed63********\\n 17649847********\\n 2021-09-24T18:22:03Z\\n","errorExample":""}]', 'title' => 'DescribeEncryptionKey', 'description' => 'Before you call this operation, TDE must be enabled for the Tair (Redis OSS-compatible) instance by using a custom key. For more information, see [ModifyInstanceTDE](~~473859~~).'."\n" ."\n" .'> For more information about TDE, see [Enable TDE](~~265913~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-03-13T12:02:38.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-26T09:46:19.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEncryptionKey'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeEncryptionKey', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeEncryptionKeyList' => [ 'summary' => 'Queries a list of custom keys used by Tair (Redis OSS-compatible) instances.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56398', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreDER7E8', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '10E2160B-959C-5C3E-BFE6-86EC5925****', 'title' => ''], 'KeyIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'KeyId' => [ 'description' => 'The custom keys that are available in the region.'."\n", 'type' => 'array', 'items' => ['description' => 'The custom key.'."\n", 'type' => 'string', 'example' => 'a0e7e2c9-8ee5-40ed-bbca-7dbc********', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeEncryptionKeyList', 'description' => '* You can specify a custom key when you call the [ModifyInstanceTDE](~~473859~~) operation to enable Transparent Data Encryption (TDE). You can call the DescribeEncryptionKeyList operation to query the custom keys that are in use. To create a custom key, you can call the [CreateKey](~~28947~~) operation of Key Management Service (KMS).'."\n" .'* For more information about TDE and the usage notes of TDE, see [Enable TDE](~~265913~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-03-25T11:17:53.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEncryptionKeyList'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeEncryptionKeyList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"10E2160B-959C-5C3E-BFE6-86EC5925****\\",\\n \\"KeyIds\\": {\\n \\"KeyId\\": [\\n \\"a0e7e2c9-8ee5-40ed-bbca-7dbc********\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 10E2160B-959C-5C3E-BFE6-86EC5925****\\n \\n a0e7e2c9-8ee5-40ed-bbca-7dbc********\\n ad463061-992d-4195-8a94-ed63********\\n \\n","errorExample":""}]', ], 'DescribeEngineVersion' => [ 'summary' => 'Queries the major version and minor version of a Tair (Redis OSS-compatible) instance and the release notes for minor versions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56399', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. You can call the [DescribeInstances](~~473778~~) operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'IsLatestVersion' => ['description' => 'Indicates whether the instance uses the latest minor version. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A52974D1-9D57-4805-86CC-92E6EDE8****', 'title' => ''], 'ProxyMinorVersion' => ['description' => 'The current minor version of the proxy node.'."\n" ."\n" .'> This parameter is returned only for cluster and read/write splitting instances.'."\n", 'type' => 'string', 'example' => '6.6.0', 'title' => ''], 'DBVersionRelease' => ['description' => 'The release notes for the minor version of the instance, including the release date, minor version number, release type such as new feature, and description.'."\n", 'type' => 'string', 'example' => '{\\"releaseInfo\\":{\\"createTime\\":\\"2021-07-27\\",\\"level\\":1,\\"releaseVersion\\":\\"0.5.4\\",\\"releaseNote\\":\\"功能更新：增强稳定性。\\"}],\\"versionChangesLevel\\":2}', 'title' => ''], 'ProxyVersionRelease' => ['description' => 'The release notes for the minor version of proxy nodes. The release notes include the release date, minor version number, release type such as new feature, and description.'."\n" ."\n" .'> This parameter is returned only for cluster and read/write splitting instances.'."\n", 'type' => 'string', 'example' => '{\\"releaseInfo\\":[{\\"createTime\\":\\"2021-06-08\\",\\"level\\":0,\\"releaseVersion\\":\\"6.6.2\\",\\"releaseNote\\":\\"新特性：增加对部分内部命令的支持。\\"}],\\"versionChangesLevel\\":2}', 'title' => ''], 'EnableUpgradeMajorVersion' => ['description' => 'Indicates whether the instance major version can be upgraded. Valid values:'."\n" ."\n" .'* **true**: The major version can be upgraded.'."\n" .'* **false**: The major version is the latest version and cannot be upgraded.'."\n" ."\n" .'> To upgrade the major version, call the [ModifyInstanceMajorVersion](~~473776~~) operation.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EnableUpgradeMinorVersion' => ['description' => 'Indicates whether the instance minor version can be updated. Valid values:'."\n" ."\n" .'* **true**: The minor version can be updated.'."\n" .'* **false**: The minor version is the latest version and cannot be updated.'."\n" ."\n" .'> To update the minor version, call the [ModifyInstanceMinorVersion](~~473777~~) operation.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'MajorVersion' => ['description' => 'The major version of the instance.'."\n", 'type' => 'string', 'example' => '5.0', 'title' => ''], 'Engine' => ['description' => 'The database engine. Valid values: **redis** and **memcache**.'."\n", 'type' => 'string', 'example' => 'redis', 'title' => ''], 'MinorVersion' => ['description' => 'The current minor version of the instance.'."\n", 'type' => 'string', 'example' => 'redis-5.0_0.5.0', 'title' => ''], 'IsRedisCompatibleVersion' => ['description' => 'Indicates whether the instance runs a Redis version.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'IsSSLEnable' => ['description' => 'Indicates whether SSL is enabled. Valid values:'."\n" ."\n" .'* **1**: SSL is enabled.'."\n" .'* **0**: TLS is disabled.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'IsNewSSLMode' => ['description' => 'Indicates whether Transport Layer Security (TLS) is enabled. Valid values:'."\n" ."\n" .'* **1**: TLS is enabled.'."\n" .'* **0**: TLS is disabled.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'IsAutoUpgradeOpen' => ['description' => 'Indicates whether automatic minor version update is enabled. Valid values:'."\n" ."\n" .'* **0**: Automatic minor version update is disabled.'."\n" .'* **1**: Automatic minor version update is enabled.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'DBLatestMinorVersion' => [ 'description' => 'The latest minor version to which the instance can be updated.'."\n", 'type' => 'object', 'properties' => [ 'MinorVersion' => ['description' => 'The version number.'."\n", 'type' => 'string', 'example' => '7.0.1.4', 'title' => ''], 'Level' => ['description' => 'The version update level. Valid values:'."\n" ."\n" .'* **0**: regular'."\n" .'* **1**: recommended'."\n" .'* **2**: critical'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'VersionRelease' => [ 'description' => 'The version update path from the current minor version to the latest minor version of the instance, which is consistent with the version documentation. For more detailed information, you can directly refer to the release notes.'."\n", 'type' => 'object', 'properties' => [ 'VersionChangesLevel' => ['description' => 'The version update level, which indicates how strongly the update is recommended. Valid values:'."\n" ."\n" .'* 0: regular'."\n" .'* 1: recommended'."\n" .'* 2: critical'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'ReleaseInfo' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReleaseInfoList' => [ 'description' => 'The information about the minor versions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The minor version information.'."\n", 'type' => 'object', 'properties' => [ 'ReleaseVersion' => ['description' => 'The release version of EMR.'."\n", 'type' => 'string', 'example' => 'EMR-5.7.0', 'title' => ''], 'CreateTime' => ['description' => 'The creation time of the instance.'."\n", 'type' => 'string', 'example' => '2022-11-21T13:28Z', 'title' => ''], 'ReleaseNote' => ['description' => 'The release notes.'."\n", 'type' => 'string', 'example' => '发布说明', 'title' => ''], 'Level' => ['description' => 'The importance level.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'ReleaseNoteEn' => ['description' => 'The description of the minor versions to which the instance can be updated.'."\n", 'type' => 'string', 'example' => '版本升级英文描述', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'ProxyLatestMinorVersion' => [ 'description' => 'The latest minor version to which the proxy node can be updated.'."\n", 'type' => 'object', 'properties' => [ 'MinorVersion' => ['description' => 'The version number.'."\n", 'type' => 'string', 'example' => '7.0.6', 'title' => ''], 'Level' => ['description' => 'The version update level. Valid values:'."\n" ."\n" .'* **0**: regular'."\n" .'* **1**: recommended'."\n" .'* **2**: critical'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'VersionRelease' => [ 'description' => 'The version update path from the current minor version to the latest minor version of the instance, which is consistent with the version documentation. For more detailed information, you can directly refer to the release notes.'."\n", 'type' => 'object', 'properties' => [ 'ReleaseInfo' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ReleaseInfoList' => [ 'description' => 'The information about the minor versions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The minor version information.'."\n", 'type' => 'object', 'properties' => [ 'ReleaseVersion' => ['description' => 'The release version of EMR.'."\n", 'type' => 'string', 'example' => 'EMR-5.9.1', 'title' => ''], 'CreateTime' => ['description' => 'The time when the version was released.'."\n", 'type' => 'string', 'example' => '2022-08-23T14:26:20Z', 'title' => ''], 'ReleaseNote' => ['description' => 'The release notes.'."\n", 'type' => 'string', 'example' => 'x x x x', 'title' => ''], 'Level' => ['description' => 'The version update level. Valid values:'."\n" ."\n" .'* **0**: regular'."\n" .'* **1**: recommended'."\n" .'* **2**: critical'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'ReleaseNoteEn' => ['description' => 'The description of the minor versions to which the instance can be updated.'."\n", 'type' => 'string', 'example' => '版本升级英文描述', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'VersionChangesLevel' => ['description' => 'The version update level, which indicates how strongly the update is recommended. Valid values:'."\n" ."\n" .'* 0: regular'."\n" .'* 1: recommended'."\n" .'* 2: critical'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'IsOpenNGLB' => ['description' => 'Indicates whether the NGLB mode is enabled. Valid values:'."\n" ."\n" .'* **0**: The NGLB mode is disabled.'."\n" .'* **1**: The NGLB mode is enabled.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsLatestVersion\\": false,\\n \\"RequestId\\": \\"A52974D1-9D57-4805-86CC-92E6EDE8****\\",\\n \\"ProxyMinorVersion\\": \\"6.6.0\\",\\n \\"DBVersionRelease\\": \\"{\\\\\\\\\\\\\\"releaseInfo\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"createTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2021-07-27\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"releaseVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0.5.4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"releaseNote\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"功能更新：增强稳定性。\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"versionChangesLevel\\\\\\\\\\\\\\":2}\\",\\n \\"ProxyVersionRelease\\": \\"{\\\\\\\\\\\\\\"releaseInfo\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"createTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2021-06-08\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"releaseVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"6.6.2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"releaseNote\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"新特性：增加对部分内部命令的支持。\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"versionChangesLevel\\\\\\\\\\\\\\":2}\\",\\n \\"EnableUpgradeMajorVersion\\": true,\\n \\"EnableUpgradeMinorVersion\\": true,\\n \\"MajorVersion\\": \\"5.0\\",\\n \\"Engine\\": \\"redis\\",\\n \\"MinorVersion\\": \\"redis-5.0_0.5.0\\",\\n \\"IsRedisCompatibleVersion\\": \\"1\\",\\n \\"IsSSLEnable\\": \\"1\\",\\n \\"IsNewSSLMode\\": \\"1\\",\\n \\"IsAutoUpgradeOpen\\": \\"0\\",\\n \\"DBLatestMinorVersion\\": {\\n \\"MinorVersion\\": \\"7.0.1.4\\",\\n \\"Level\\": \\"0\\",\\n \\"VersionRelease\\": {\\n \\"VersionChangesLevel\\": \\"0\\",\\n \\"ReleaseInfo\\": {\\n \\"ReleaseInfoList\\": [\\n {\\n \\"ReleaseVersion\\": \\"EMR-5.7.0\\",\\n \\"CreateTime\\": \\"2022-11-21T13:28Z\\",\\n \\"ReleaseNote\\": \\"发布说明\\",\\n \\"Level\\": \\"0\\",\\n \\"ReleaseNoteEn\\": \\"版本升级英文描述\\"\\n }\\n ]\\n }\\n }\\n },\\n \\"ProxyLatestMinorVersion\\": {\\n \\"MinorVersion\\": \\"7.0.6\\",\\n \\"Level\\": \\"0\\",\\n \\"VersionRelease\\": {\\n \\"ReleaseInfo\\": {\\n \\"ReleaseInfoList\\": [\\n {\\n \\"ReleaseVersion\\": \\"EMR-5.9.1\\",\\n \\"CreateTime\\": \\"2022-08-23T14:26:20Z\\",\\n \\"ReleaseNote\\": \\"x x x x\\",\\n \\"Level\\": \\"0\\",\\n \\"ReleaseNoteEn\\": \\"版本升级英文描述\\"\\n }\\n ]\\n },\\n \\"VersionChangesLevel\\": \\"0\\"\\n }\\n },\\n \\"IsOpenNGLB\\": \\"1\\"\\n}","errorExample":"{\\n \\"MinorVersion\\":\\"redis_0.12.4\\",\\n \\"IsLatestVersion\\":\\"false\\",\\n \\"MajorVersion\\":\\"2.8\\",\\n \\"EnableUpgradeMajorVersion\\":\\"true\\",\\n \\"RequestId\\":\\"A49A2216-F6C9-43E2-A8F0-F217E57943C4\\",\\n \\"EnableUpgradeMinorVersion\\":\\"true\\",\\n \\"Engine\\":\\"redis\\"\\n}"},{"type":"xml","example":"","errorExample":" \\n \\tredis_0.12.4\\n\\tfalse\\n\\t2.8\\n\\ttrue\\n\\tA49A2216-F6C9-43E2-A8F0-F217E57943C4\\n\\ttrue\\n\\tredis\\n"}]', 'title' => 'DescribeEngineVersion', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-04-22T13:08:16.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-10-18T10:31:34.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-15T06:27:51.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-09-26T11:39:38.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeEngineVersion'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeEngineVersion', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'description' => '## Debugging'."\n" ."\n" .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=R-kvstore\\&api=DescribeEngineVersion\\&type=RPC\\&version=2015-01-01)'."\n", ], 'DescribeGlobalDistributeCache' => [ 'summary' => 'Queries the details of a distributed Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56401', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'GlobalInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the distributed instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gr-bp14rkqrhac****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. The value must be an integer that is greater than **0**. Default value: **1**.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return each page.'."\n", 'type' => 'string', 'required' => false, 'example' => '20', 'default' => '20', 'title' => ''], ], [ 'name' => 'SubInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the child instance that is attached to the distributed instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gr-bp1zcjlobkyrq****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F3F44BE3-5419-4B61-9BAC-E66E295A****', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'GlobalDistributeCaches' => [ 'description' => 'Details of the distributed instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The state of the distributed instance. Valid values:'."\n" ."\n" .'* **Normal**: The instance is normal.'."\n" .'* **Changing**: The configurations of the instance are being changed.'."\n" .'* **Creating**: The instance is being created.'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'GlobalInstanceId' => ['description' => 'The ID of the distributed instance.'."\n", 'type' => 'string', 'example' => 'gr-bp14rkqrhac****', 'title' => ''], 'SubInstances' => [ 'description' => 'Details of the child instances.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceStatus' => ['description' => 'The state of the child instance. Valid values:'."\n" ."\n" .'* **Normal**: The instance is normal.'."\n" .'* **Creating**: The instance is being created.'."\n" .'* **Changing**: The configurations of the instance are being changed.'."\n" .'* **Inactive**: The instance is disabled.'."\n" .'* **Flushing**: The instance is being released.'."\n" .'* **Released**: The instance is released.'."\n" .'* **Transforming**: The billing method of the instance is changing.'."\n" .'* **Unavailable**: The instance is suspended.'."\n" .'* **Error**: The instance failed to be created.'."\n" .'* **Migrating**: The instance is being migrated.'."\n" .'* **BackupRecovering**: The instance is being restored from a backup.'."\n" .'* **MinorVersionUpgrading**: The minor version of the instance is being updated.'."\n" .'* **NetworkModifying**: The network type of the instance is being changed.'."\n" .'* **SSLModifying**: The SSL certificate of the instance is being changed.'."\n" .'* **MajorVersionUpgrading**: The major version of the instance is being upgraded. The instance remains available during the upgrade.'."\n" ."\n" .'> For more information about instance states, see [Instance states and impacts](~~200740~~).'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'InstanceID' => ['description' => 'The ID of the child instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'InstanceClass' => ['description' => 'The instance type of the child instance. For more information, see the following topics:'."\n" ."\n" .'* [Standard DRAM-based instances](~~145228~~)'."\n" .'* [Cluster DRAM-based instances](~~150458~~)'."\n" .'* [Read/write splitting DRAM-based instances](~~150459~~)'."\n", 'type' => 'string', 'example' => 'redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread', 'title' => ''], 'GlobalInstanceId' => ['description' => 'The ID of the distributed instance.'."\n", 'type' => 'string', 'example' => 'gr-bp14rkqrhac****', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"F3F44BE3-5419-4B61-9BAC-E66E295A****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalRecordCount\\": 1,\\n \\"GlobalDistributeCaches\\": [\\n {\\n \\"Status\\": \\"Normal\\",\\n \\"GlobalInstanceId\\": \\"gr-bp14rkqrhac****\\",\\n \\"SubInstances\\": [\\n {\\n \\"InstanceStatus\\": \\"Normal\\",\\n \\"InstanceID\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"InstanceClass\\": \\"redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread\\",\\n \\"GlobalInstanceId\\": \\"gr-bp14rkqrhac****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1\\r\\n \\r\\n Normal\\r\\n \\r\\n r-bp14of12k0f0lw****\\r\\n Normal\\r\\n gr-bp1zcjlobkyrq****\\r\\n redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread\\r\\n cn-hangzhou\\r\\n \\r\\n gr-bp1zcjlobkyrq****\\r\\n \\r\\n F3F44BE3-5419-4B61-9BAC-E66E295A****\\r\\n 20\\r\\n 1\\r\\n","errorExample":""}]', 'title' => 'DescribeGlobalDistributeCache', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-03-25T11:17:53.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalDistributeCache'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeGlobalDistributeCache', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'description' => '## Debugging'."\n" ."\n" .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=R-kvstore\\&api=DescribeGlobalDistributeCache\\&type=RPC\\&version=2015-01-01)'."\n", ], 'DescribeGlobalSecurityIPGroup' => [ 'summary' => 'Queries global IP whitelist templates.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '169265', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the global IP whitelist template.', 'type' => 'string', 'required' => false, 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'type' => 'string', 'default' => 'redis', 'enum' => ['redis', 'memcache'], 'description' => '', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '2FF6158E-3394-4A90-B634-79C49184****', 'title' => ''], 'GlobalSecurityIPGroup' => [ 'description' => 'An array of global IP whitelist templates.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GlobalSecurityGroupId' => ['description' => 'The ID of the global IP whitelist template.', 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], 'GlobalIgName' => ['description' => 'The name of the global IP whitelist template.', 'type' => 'string', 'example' => 'test_123', 'title' => ''], 'GIpList' => ['description' => 'The IP addresses in the global IP whitelist template.'."\n" ."\n" .'> Separate multiple IP addresses with a comma.', 'type' => 'string', 'example' => '192.168.0.1,10.10.10.10', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'DBInstances' => [ 'description' => 'An array of instance IDs that are associated with the global IP whitelist template.', 'type' => 'array', 'items' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'r-t4n885e834f6****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '1'."\n", 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Missing input parameter'], ['errorCode' => 'InvalidAction', 'errorMessage' => 'Specified action is not valid.', 'description' => ''], ], 404 => [ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FF6158E-3394-4A90-B634-79C49184****\\",\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GIpList\\": \\"192.168.0.1,10.10.10.10\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DBInstances\\": [\\n \\"r-t4n885e834f6****\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeGlobalSecurityIPGroup', 'changeSet' => [ ['createdAt' => '2025-10-30T14:42:35.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalSecurityIPGroup'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeGlobalSecurityIPGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeGlobalSecurityIPGroupRelation' => [ 'summary' => 'Queries information about the global IP whitelist templates associated with an instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-t4n885e834f6****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-t4n885e834f6****', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', 'title' => ''], 'GlobalSecurityIPGroupRel' => [ 'description' => 'The information about the associated global IP whitelist template.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GlobalSecurityGroupId' => ['description' => 'The ID of the IP whitelist template.'."\n", 'type' => 'string', 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], 'GIpList' => ['description' => 'The IP address in the IP whitelist template.'."\n" ."\n" .'> Multiple IP addresses are separated by commas (,).'."\n", 'type' => 'string', 'example' => '192.168.0.1,10.10.10.10', 'title' => ''], 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'GlobalIgName' => ['description' => 'The name of the IP whitelist template.'."\n", 'type' => 'string', 'example' => 'test_123', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Missing input parameter'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBClusterId\\": \\"r-t4n885e834f6****\\",\\n \\"RequestId\\": \\"9B7BFB11-C077-4FE3-B051-F69CEB******\\",\\n \\"GlobalSecurityIPGroupRel\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-zsldxfiwjmti0kcm****\\",\\n \\"GIpList\\": \\"192.168.0.1,10.10.10.10\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GlobalIgName\\": \\"test_123\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeGlobalSecurityIPGroupRelation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalSecurityIPGroupRelation'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeGlobalSecurityIPGroupRelation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeHistoryEvents' => [ 'summary' => 'DescribeHistoryEvents', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '194560', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records to return on each page. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'ArchiveStatus', 'in' => 'query', 'schema' => ['description' => 'The status of the event. Valid values:'."\n" ."\n" .'* **Archived**'."\n" .'* **UnArchived**'."\n" .'* **All**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Archived', 'title' => ''], ], [ 'name' => 'EventCategory', 'in' => 'query', 'schema' => ['description' => 'The system event category. Valid values:'."\n" ."\n" .'* **Exception**: abnormal events.'."\n" .'* **Optimize**: optimization events.'."\n" .'* **Notification**: Notification events.'."\n" .'* **Maintenance**: scheduled maintenance events.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Exception', 'title' => ''], ], [ 'name' => 'EventType', 'in' => 'query', 'schema' => ['description' => 'The system event type. This parameter takes effect only when InstanceEventType.N is not specified. Valid values:'."\n" ."\n" .'* SystemMaintenance.Reboot: The instance is restarted due to system maintenance.'."\n" .'* SystemMaintenance.Redeploy: The instance is redeployed due to system maintenance.'."\n" .'* SystemFailure.Reboot: The instance is restarted due to a system error.'."\n" .'* SystemFailure.Redeploy: The instance is redeployed due to a system error.'."\n" .'* SystemFailure.Delete: The instance is released due to an instance creation failure.'."\n" .'* InstanceFailure.Reboot: The instance is restarted due to an instance error.'."\n" .'* InstanceExpiration.Stop: The subscription instance is stopped due to expiration.'."\n" .'* InstanceExpiration.Delete: The subscription instance is released due to expiration.'."\n" .'* AccountUnbalanced.Stop: The pay-as-you-go instance is stopped due to an overdue payment.'."\n" .'* AccountUnbalanced.Delete: The pay-as-you-go instance is released due to an overdue payment.'."\n" ."\n" .'> For more information about event types, see [Overview of system events](~~66574~~). The values of this parameter are applicable only to instance system events, but not to disk system events.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SystemFailure.Reboot'."\n", 'title' => ''], ], [ 'name' => 'EventLevel', 'in' => 'query', 'schema' => ['description' => 'The level of the event. Valid values:'."\n" ."\n" .'* **INFO**'."\n" .'* **WARN**'."\n" .'* **CRITICAL**'."\n", 'type' => 'string', 'required' => false, 'example' => 'INFO', 'title' => ''], ], [ 'name' => 'EventStatus', 'in' => 'query', 'schema' => ['description' => 'The status of the event. Valid values:'."\n" ."\n" .'* **Inquiring**'."\n" .'* **Scheduled**: Planned'."\n" .'* **Running**'."\n" .'* **Succeed**'."\n" .'* **Failed**'."\n" .'* **Canceled**'."\n" ."\n" .'> Separate multiple states with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Scheduled', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The type of the resource. Valid values:'."\n" ."\n" .'* **Instance**: instance resources.'."\n" .'* **Host**: host resources.'."\n" .'* **User**: user resources'."\n" ."\n" .'> If you do not specify this parameter, events of all resource types are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Instance', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => ['description' => 'The event ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '5345398', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The task IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => '578678678', 'title' => ''], ], [ 'name' => 'FromStartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-01-02T11:31:03Z', 'title' => ''], ], [ 'name' => 'ToStartTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Only events that have a start time earlier than or equal to the time specified by this parameter are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-02-02T11:31:03Z', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfnuslkubs****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '27B911BF-4E17-5F8A-A932-79DF2D3F****', 'title' => ''], 'PageSize' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'TotalCount' => ['description' => 'The total number of returned events.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '430', 'title' => ''], 'Items' => [ 'description' => 'A list of events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The queried event.'."\n", 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '4309', 'title' => ''], 'Region' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hanghzou', 'title' => ''], 'Source' => ['description' => 'The source of the event.'."\n", 'type' => 'string', 'example' => 'loanBill', 'title' => ''], 'Specversion' => ['description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '8.0', 'title' => ''], 'Subject' => ['description' => 'The name of the pending event.'."\n", 'type' => 'string', 'example' => 'Qitian', 'title' => ''], 'Time' => ['description' => 'The amount of time that has elapsed from the start time of the query. Unit: seconds.'."\n", 'type' => 'string', 'example' => '1734919325126', 'title' => ''], 'Type' => ['description' => 'The type of the event.'."\n", 'type' => 'string', 'example' => 'host', 'title' => ''], 'Data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'EventType' => ['description' => 'The type of the system event. Valid values:'."\n" ."\n" .'* **SystemMaintenance.Reboot**: The instance was restarted due to system maintenance.'."\n" .'* **SystemMaintenance.Redeploy**: The instance was redeployed due to system maintenance.'."\n" .'* **SystemFailure.Reboot**: The instance was restarted due to system failures.'."\n" .'* **SystemFailure.Redeploy**: The instance was redeployed due to system failures.'."\n" .'* **SystemFailure.Delete**: The instance was released due to an instance creation failure.'."\n" .'* **InstanceFailure.Reboot**: The instance was restarted due to an instance error.'."\n" .'* **InstanceExpiration.Stop**: The subscription instance was stopped due to expiration.'."\n" .'* **InstanceExpiration.Delete**: The subscription instance was released due to expiration.'."\n" .'* **AccountUnbalanced.Stop**: The pay-as-you-go instance is stopped due to an overdue payment.'."\n" .'* **AccountUnbalanced.Delete**: The pay-as-you-go instance was released due to an overdue payment.'."\n", 'type' => 'string', 'example' => 'StatusNotification', 'title' => ''], 'EventId' => ['description' => 'The ID of the event.'."\n", 'type' => 'string', 'example' => '669036', 'title' => ''], 'CmsProduct' => ['description' => 'The cloud service type of the application group. Valid values:'."\n" ."\n" .'* **web**: web application.'."\n" .'* **native**: local application.'."\n", 'type' => 'string', 'example' => 'web', 'title' => ''], 'DbType' => ['description' => 'The database type.'."\n", 'type' => 'string', 'example' => 'redis', 'title' => ''], 'DetailImpact' => ['description' => 'The pagination parameter.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], 'DetailReason' => ['description' => 'The details of the instance operation.'."\n", 'type' => 'string', 'example' => 'xxxx', 'title' => ''], 'EndTime' => ['description' => 'The time when the alert was closed.'."\n", 'type' => 'string', 'example' => '2023-03-06T11:46:01Z'."\n", 'title' => ''], 'EventCategory' => ['description' => 'The system event category. Valid values:'."\n" ."\n" .'* **Exception**: abnormal events'."\n" .'* **Optimize**: optimization events.'."\n" .'* **Notification**: notification events.'."\n" .'* **Maintenance**: scheduled maintenance events.'."\n", 'type' => 'string', 'example' => 'Exception', 'title' => ''], 'EventCode' => ['description' => 'The event code.'."\n", 'type' => 'string', 'example' => 'ENT000014'."\n", 'title' => ''], 'EventDetail' => ['description' => 'The event details.'."\n", 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'EventImpact' => ['description' => 'The event impact.'."\n", 'type' => 'string', 'example' => 'xxxxx'."\n", 'title' => ''], 'EventLevel' => ['description' => 'The level of the event. Valid values:'."\n" ."\n" .'* **INFO**'."\n" .'* **WARN**'."\n" .'* **CRITICAL**'."\n", 'type' => 'string', 'example' => 'INFO', 'title' => ''], 'EventReason' => ['description' => 'The event source.'."\n", 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'EventStatus' => ['description' => 'The status of the event. Valid values:'."\n" ."\n" .'* **Inquiring**'."\n" .'* **Scheduled**'."\n" .'* **Running**'."\n" .'* **Succeed**'."\n" .'* **Failed**'."\n" .'* **Canceled**'."\n", 'type' => 'string', 'example' => 'Succeed', 'title' => ''], 'GmtCreated' => ['description' => 'The time when the event was created.'."\n", 'type' => 'string', 'example' => '2024-12-13 05:34:23', 'title' => ''], 'GmtModified' => ['description' => 'The time when the event was updated.'."\n", 'type' => 'string', 'example' => '2025-03-05 10:41:59', 'title' => ''], 'HandleStatus' => ['description' => 'The status of the event. Valid values:'."\n", 'type' => 'string', 'example' => 'done', 'title' => ''], 'HasLifeCycle' => ['description' => 'Indicates whether the event has a lifecycle.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'false', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp15kjsoovqjam****', 'title' => ''], 'InstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'normandy', 'title' => ''], 'IsClosed' => ['description' => 'Indicates whether the event is closed. Valid values:'."\n" ."\n" .'* **0**: closed.'."\n" .'* **1**: not closed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Product' => ['description' => 'The name of the product.'."\n", 'type' => 'string', 'example' => 'kvstore', 'title' => ''], 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'ResourceType' => ['description' => 'The resource type of the instance. Valid values:'."\n" ."\n" .'* **Instance**: instance resources.'."\n" .'* **Host**: host resources.'."\n" .'* **User**: user resources.'."\n", 'type' => 'string', 'example' => 'Instance', 'title' => ''], 'SourceType' => ['description' => 'The type of the source data.'."\n", 'type' => 'string', 'example' => 'MSE', 'title' => ''], 'StartTime' => ['description' => 'The start time of the event.'."\n", 'type' => 'string', 'example' => '2025-09-30T21:13Z', 'title' => ''], 'Uid' => ['description' => 'The ID of the user to which the resources belong.'."\n", 'type' => 'string', 'example' => '15532817595*****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"27B911BF-4E17-5F8A-A932-79DF2D3F****\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 430,\\n \\"Items\\": [\\n {\\n \\"Id\\": \\"4309\\",\\n \\"Region\\": \\"cn-hanghzou\\",\\n \\"Source\\": \\"loanBill\\",\\n \\"Specversion\\": \\"8.0\\",\\n \\"Subject\\": \\"Qitian\\",\\n \\"Time\\": \\"1734919325126\\",\\n \\"Type\\": \\"host\\",\\n \\"Data\\": {\\n \\"EventType\\": \\"StatusNotification\\",\\n \\"EventId\\": \\"669036\\",\\n \\"CmsProduct\\": \\"web\\",\\n \\"DbType\\": \\"redis\\",\\n \\"DetailImpact\\": \\"1\\",\\n \\"DetailReason\\": \\"xxxx\\",\\n \\"EndTime\\": \\"2023-03-06T11:46:01Z\\\\n\\",\\n \\"EventCategory\\": \\"Exception\\",\\n \\"EventCode\\": \\"ENT000014\\\\n\\",\\n \\"EventDetail\\": \\"xxxxx\\",\\n \\"EventImpact\\": \\"xxxxx\\\\n\\",\\n \\"EventLevel\\": \\"INFO\\",\\n \\"EventReason\\": \\"xxxxx\\",\\n \\"EventStatus\\": \\"Succeed\\",\\n \\"GmtCreated\\": \\"2024-12-13 05:34:23\\",\\n \\"GmtModified\\": \\"2025-03-05 10:41:59\\",\\n \\"HandleStatus\\": \\"done\\",\\n \\"HasLifeCycle\\": 0,\\n \\"InstanceId\\": \\"r-bp15kjsoovqjam****\\",\\n \\"InstanceName\\": \\"normandy\\",\\n \\"IsClosed\\": 0,\\n \\"Product\\": \\"kvstore\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceType\\": \\"Instance\\",\\n \\"SourceType\\": \\"MSE\\",\\n \\"StartTime\\": \\"2025-09-30T21:13Z\\",\\n \\"Uid\\": \\"15532817595*****\\"\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeHistoryEvents', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryEvents'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:DescribeHistoryEvents', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeHistoryEventsStat' => [ 'summary' => 'Queries the statistics of historical events.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '194561', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'ArchiveStatus', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The status of the events that you want to query. Valid values:'."\n" ."\n" .'* **Archived**'."\n" .'* **UnArchived**'."\n" .'* **All**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Archived', 'title' => ''], ], [ 'name' => 'FromStartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Only tasks that have a start time later than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The start time can be up to 30 days earlier than the current time. If you set this parameter to a time more than 30 days earlier than the current time, this time is automatically converted to a time that is exactly 30 days earlier than the current time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-01-02T11:31:03Z', 'title' => ''], ], [ 'name' => 'ToStartTime', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The end of the time range to query. Only tasks that have a start time earlier than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-02-02T11:31:03Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B32A350C-3A8E-5FF1-A56F-51C3769D****', 'title' => ''], 'Items' => [ 'description' => 'The queried events.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of events.'."\n", 'type' => 'object', 'properties' => [ 'EventCategory' => ['description' => 'The system event category. Valid values:'."\n" ."\n" .'* **Exception**: abnormal events'."\n" .'* **Optimize**: optimization events.'."\n" .'* **Notification**: notification events.'."\n" .'* **Maintenance**: scheduled maintenance events.'."\n", 'type' => 'string', 'example' => 'Exception', 'title' => ''], 'TotalCount' => ['description' => 'The total number of returned events.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '21', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B32A350C-3A8E-5FF1-A56F-51C3769D****\\",\\n \\"Items\\": [\\n {\\n \\"EventCategory\\": \\"Exception\\",\\n \\"TotalCount\\": 21\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeHistoryEventsStat', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryEventsStat'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeHistoryEventsStat', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeHistoryMonitorValues' => [ 'summary' => 'View performance monitoring data for an ApsaraDB for Tair (Redis-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56402', 'abilityTreeNodes' => ['FEATUREkvstoreW1V0SW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx******', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-11-06T00:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> You can query monitoring data within the past month. The maximum time range to query is 7 days.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-11-06T00:30:00Z', 'title' => ''], ], [ 'name' => 'IntervalForHistory', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated and its value is fixed at `01m`.'."\n" ."\n" .'The system automatically determines the **query interval** based on the specified start and end times. For example, if the specified time range is 10 minutes or less, data is aggregated every 5 seconds, and the query results are returned at 5-second intervals.'."\n" ."\n" .'> - If the specified `StartTime` is not at a data aggregation point, the first time point returned by the system is the nearest preceding data aggregation point. For example, if you set StartTime to `2022-01-20T12:01:48Z`, the first time point returned is `2022-01-20T12:01:45Z`.'."\n" .'>'."\n" .'> - If the instance has 32 or more data shards, the minimum data aggregation frequency is 1 minute.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enum' => ['01m', '05m', '15m', '60m'], 'example' => '01m', 'title' => '', ], ], [ 'name' => 'MonitorKeys', 'in' => 'query', 'schema' => ['description' => 'The monitoring metric to query, such as `CpuUsage`. To specify multiple metrics, separate them with a comma (,).'."\n" ."\n" .'- For instances that use the cluster or read/write splitting architecture:'."\n" ."\n" .' - To query the overall CPU utilization of all data nodes, set this parameter to **CpuUsage$db**.'."\n" ."\n" .' - To query the CPU utilization of a single data node, set this parameter to **CpuUsage** and specify the node in the `NodeId` parameter.'."\n" ."\n" .'- For instances that use the standard architecture (primary/standby), set this parameter to **CpuUsage**.'."\n" ."\n" .'For more information about monitoring metrics, see [Additional information about the MonitorKeys parameter](https://help.aliyun.com/zh/redis/developer-reference/api-r-kvstore-2015-01-01-describehistorymonitorvalues-redis#monitorKeys-note)[Additional information about the MonitorKeys parameter](https://www.alibabacloud.com/help/zh/redis/developer-reference/api-r-kvstore-2015-01-01-describehistorymonitorvalues-redis#monitorKeys-note) below.'."\n" ."\n" .'> - If you do not specify this parameter, the `UsedMemory` and `quotaMemory` metrics are returned by default.'."\n" .'>'."\n" .'> - To ensure query efficiency, we recommend that you specify a maximum of 5 monitoring metrics for a single node and a maximum of 1 aggregate monitoring metric per query.', 'type' => 'string', 'required' => false, 'example' => 'CpuUsage', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of a node in the instance. You can use this parameter to query the monitoring data of a specific node.'."\n" ."\n" .'> - This parameter is available only for instances that use the read/write splitting or cluster architecture.'."\n" .'>'."\n" .'> - You can call the [DescribeLogicInstanceTopology](~~473786~~) operation to query node IDs.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****-db-0#1679****', 'title' => ''], ], [ 'name' => 'NodeRole', 'in' => 'query', 'schema' => ['description' => 'If you want to query the metrics of a read-only node in a cloud-native instance that uses a read/write splitting architecture, you must specify the **NodeId** and set this parameter to **READONLY**.'."\n" ."\n" .'> In all other cases, you do not need to specify this parameter. You can also set it to **MASTER**.', 'type' => 'string', 'required' => false, 'example' => 'READONLY', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'MonitorHistory' => ['description' => 'The monitoring data returned as a JSON-formatted string. For more information, see [Monitoring parameters](~~122091~~).'."\n" ."\n" .'> To improve data transfer efficiency, the system returns only monitoring data for metrics with non-zero values. If a metric is not returned, its value is **0**.', 'type' => 'string', 'example' => '"{\\"2022-11-06T00:00:00Z\\":{\\"memoryUsage\\":\\"6.67\\"},\\"2022-11-06T00:00:05Z\\":{\\"memoryUsage\\":\\"6.67\\"},\\"2022-11-06T00:00:10Z\\":{\\"memoryUsage\\":\\"6.67\\"},\\"2022-11-06T00:00:15Z\\":{\\"memoryUsage\\":\\"6.67\\"},\\"2022-11-06T00:00:20Z\\":{\\"memoryUsage\\":\\"6.67\\"},\\"2022-11-06T00:00:25Z\\":{\\"memoryUsage\\":\\"6.67\\"}}"', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F0997EE8-F4C2-4503-9168-85177ED7****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The Specified parameter "StartTime" is not valid.', 'description' => ''], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The Specified parameter "EndTime" is not valid.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MonitorHistory\\": \\"\\\\\\"{\\\\\\\\\\\\\\"2022-11-06T00:00:00Z\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"memoryUsage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"6.67\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"2022-11-06T00:00:05Z\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"memoryUsage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"6.67\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"2022-11-06T00:00:10Z\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"memoryUsage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"6.67\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"2022-11-06T00:00:15Z\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"memoryUsage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"6.67\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"2022-11-06T00:00:20Z\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"memoryUsage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"6.67\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"2022-11-06T00:00:25Z\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"memoryUsage\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"6.67\\\\\\\\\\\\\\"}}\\\\\\"\\",\\n \\"RequestId\\": \\"F0997EE8-F4C2-4503-9168-85177ED7****\\"\\n}","type":"json"}]', 'title' => 'DescribeHistoryMonitorValues', 'description' => 'For the console equivalent, see [performance monitoring](~~43887~~).', 'requestParamsDescription' => '### MonitorKeys parameter'."\n" ."\n" .'When you make an API call, pass a parameter from the **MonitorKeys** column in the following tables. The API returns the corresponding sub-metrics. An instance supports both general-purpose metrics and command statistics metrics.'."\n" ."\n" .'#### General-purpose metrics'."\n" ."\n" .'This section describes how to use general-purpose metrics, using `CpuUsage` as an example.'."\n" ."\n" .'- For instances that use the cluster or read/write splitting architecture:'."\n" ."\n" .' - To query the overall CPU utilization of all data nodes (DB), pass **CpuUsage$db**.'."\n" ."\n" .' - To query the overall CPU utilization of all proxy nodes, pass **CpuUsage$proxy**.'."\n" ."\n" .' - To query the CPU utilization of a single data node or proxy node, pass **CpuUsage** and set the `NodeId` parameter to the ID of the data or proxy node.'."\n" ."\n" .'- For instances that use the standard architecture (primary/standby), pass **CpuUsage**.'."\n" ."\n" .'| **MonitorKeys** | **Sub-metric** | **Unit** | **Description** | **Supported scope** |'."\n" .'| ------------------------- | ---------------------------------------------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |'."\n" .'| CpuUsage | CpuUsage | % | CPU utilization. The value ranges from 0 to 100.
> If your instance previously used the `RedisCpuUsage` parameter, you can continue to use it. | - DB
- DB aggregate
- Proxy
- Proxy aggregate |'."\n" .'| MemoryUsage | memoryUsage | % | Memory usage. | - DB
- DB aggregate |'."\n" .'| quotaMemory | quotaMemory | Bytes | The total memory of the current shard. | - DB
- DB aggregate |'."\n" .'| UsedMemory | UsedMemory | Bytes | Used memory, which includes data and cache. | - DB
- DB aggregate |'."\n" .'| Tair\\_PmemUsage | PmemUsage | % | These metrics represent the persistent memory usage, used persistent memory, and total persistent memory, respectively.
Supported only by persistent memory instances. | - DB
- DB aggregate |'."\n" .'| Tair\\_Pmem | PmemUsed | Bytes | | |'."\n" .'| | PmemQuota | Bytes | | |'."\n" .'| Redis\\_DetailedSpaceUsage | ins\\_size | MB | These metrics represent the total disk space occupied by the instance, the disk space occupied by data files (including AOF and RDB files), and the disk space occupied by log files (including runtime logs), respectively.
Supported only by memory-optimized instances that use the classic deployment mode (local disks). | - DB
- DB aggregate |'."\n" .'| | data\\_size | MB | | |'."\n" .'| | log\\_size | MB | | |'."\n" .'| Redis\\_Memory\\_Monitor | used\\_memory\\_rss | Bytes | The physical memory that the operating system allocates to the Tair process. | - DB |'."\n" .'| | used\\_memory\\_lua | Bytes | The amount of memory used by Lua scripts. | |'."\n" .'| | used\\_memory\\_startup | Bytes | The memory consumed when Tair starts. | |'."\n" .'| | lazyfree\\_pending\\_objects | Counts | The number of keys pending reclamation when Tair performs a lazy free operation. | |'."\n" .'| | used\\_memory\\_overhead | Bytes | The memory overhead required by Tair to maintain its internal data structures. This includes the output buffers of all clients, query buffers, and AOF. | |'."\n" .'| | used\\_memory\\_dataset | Bytes | The memory space occupied by data. | |'."\n" .'| CustomerMemoryUsage | CustomerMemoryUsage | % | User memory usage. The value ranges from 0 to 100. | - DB
- DB aggregate |'."\n" .'| UsedQPS | TotalQps | Counts/s | The total number of requests per second, including read and write commands. | - DB
- DB aggregate
- Proxy
- Proxy aggregate |'."\n" .'| | GetQps | Counts/s | The number of read and write requests per second, respectively. The instance must be compatible with Redis 4.0 or later. | |'."\n" .'| | PutQps | Counts/s | | |'."\n" .'| | OtherOps | Counts/s | The number of requests that do not have read or write attributes, such as `PING`, `INFO`, `SELECT`, and `AUTH`. Because proxy nodes have special processing for requests, if the instance has proxy nodes, this metric includes only some `INFO` requests. | |'."\n" .'| ConnectionUsage | connectionUsage | % | Connection usage is calculated by using the following formula: Established connections ÷ Total connections supported by the instance. This metric is a useful reference when a client connects to a instance (cluster architecture) using a direct connection address. | - DB
- DB aggregate |'."\n" .'| UsedConnection | ConnCount | Counts | The number of used connections. | |'."\n" .'| IntranetIn | InFlow | KB/s | The inbound and outbound traffic rates. | - DB
- DB aggregate
- Proxy
- Proxy aggregate |'."\n" .'| IntranetOut | OutFlow | KB/s | | |'."\n" .'| IntranetInRatio | intranetInRatio | % | The usage percentage of the inbound and outbound traffic bandwidth. | - DB
- DB aggregate |'."\n" .'| IntranetOutRatio | intranetOutRatio | % | | |'."\n" .'| Redis\\_Avg\\_Rt\\_Monitor | AvgRt | us | The average latency, which is the average time a backend node takes to process a command from receipt to response.
- For a data node, this metric does not include the latency of proxy nodes and load balancing.
- For a proxy node, this metric includes the latency of data nodes and proxy nodes, but does not include the latency of load balancing. | - DB
- DB aggregate
- Proxy
- Proxy aggregate |'."\n" .'| Redis\\_Max\\_Rt\\_Monitor | MaxRt | us | The maximum latency, which is the maximum time a node takes to process a command from receipt to response.
- For a data node, this metric does not include the latency of proxy nodes and load balancing.
- For a proxy node, this metric includes the latency of data nodes and proxy nodes, but does not include the latency of load balancing. | |'."\n" .'| Redis\\_Basic\\_Monitor | Keys | Counts | The total number of top-level keys stored in the instance. | - DB
- DB aggregate |'."\n" .'| | Expires | Counts | The number of keys with an expiration time set. This is an instantaneous value measured at the time of collection. | |'."\n" .'| | ExpiredKeys | Counts | The cumulative number of expired keys. | |'."\n" .'| | EvictedKeys | Counts | The cumulative number of evicted keys. | |'."\n" .'| | ExpiredKeysPerSecond | Counts/s | The number of keys that expire per second. | |'."\n" .'| | EvictedKeysPerSecond | Counts/s | The number of keys that are evicted per second. | |'."\n" .'| | inmem\\_keys | Counts | These metrics are supported only by hybrid storage instances (discontinued) and can be ignored. | |'."\n" .'| | swapped\\_keys | Counts | | |'."\n" .'| Hit\\_Rate\\_Monitor | hit\\_rate | % | The percentage of successful key lookups. Formula: Number of key hits / (Number of key hits + Number of key misses). | - DB
- DB aggregate |'."\n" .'| | hit | Counts | The number of key hits per second. | |'."\n" .'| | miss | Counts | The number of key misses per second. | |'."\n" .'| | evicted\\_keys\\_per\\_sec | Counts/s | The number of keys evicted per second. | |'."\n" .'| DiskUsage | disk\\_usage | % | These metrics represent disk usage, input buffer size, output buffer size, and disk performance. Supported only by disk-based instances. | - DB |'."\n" .'| Tair\\_Connection\\_Monitor | UsedInputBuffer | Bytes | | |'."\n" .'| | UsedOutputBuffer | Bytes | | |'."\n" .'| Tair\\_Disk\\_Monitor | `io_bandwidth_kbps`, `iops`, `iops_usage`, and more. | %, ms, Counts, and more. | | |'."\n" .'| UsedConnection | ConnectionUsage | % | Connection usage, calculated as: Used connections ÷ Maximum connections supported by the node. This metric is a useful reference when a client connects to a instance (cluster or read/write splitting architecture) through a proxy node. | - Proxy
- Proxy aggregate |'."\n" .'| | UsedConnection | Counts | The number of used connections. | |'."\n" .'| | NewUserConnQps | Counts/s | The number of connections established per second from clients to proxy nodes. | |'."\n" .'| Redis\\_Package\\_Monitor | request | Byte | The average size of a single request in bytes. | - Proxy |'."\n" .'| | response | Byte | The average size of a single response in bytes. | |'."\n" .'| | request\\_max | Byte | The maximum size of a single request in bytes. | |'."\n" .'| | response\\_max | Byte | The maximum size of a single response in bytes. | |'."\n" .'| RedisProxyConn | RedisUsedConnection | Counts | The number of connections from proxy nodes to data nodes. | |'."\n" .'| | NewDBConnQps | Counts/s | The number of connections established per second from proxy nodes to data nodes. | |'."\n" .'| | DisconnectDBConn | Counts | The cumulative number of disconnections from proxy nodes to data nodes. | |'."\n" .'| | DisconnectUserConn | Counts | The cumulative number of disconnections from clients to proxy nodes. | |'."\n" .'| TotalCalls | TotalRefusedCommands | Counts | The cumulative number of rejected commands. | |'."\n" .'| | TotalCallsPerSecCalls | Counts/s | The number of requests per second. | |'."\n" .'| | TotalCallsPerSecRetryCalls | Counts/s | The number of retried requests per second. | |'."\n" .'| | TotalCallsPerSecRetryFailed | Counts/s | The number of failed requests per second. | |'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'Command statistics metrics'."\n" ."\n" .''."\n" ."\n" .'Command statistics metrics can be queried only for a specific data node. To query these metrics, pass the corresponding **MonitorKeys** parameter and specify the data node in the `NodeId` parameter.'."\n" ."\n" .'> The Tair extension command monitoring group is supported only by memory-optimized instances that use the classic deployment mode (local disks).'."\n" ."\n" .'| **MonitorKeys** | **Sub-metric** | **Unit** | **Description** |'."\n" .'| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------- |'."\n" .'| Redis\\_Keys\\_Monitor | del, dump, exists, expire, expireat, move, persist, pexpire, pexpireat, pttl, randomkey, rename, renamenx, restore, sort, ttl, type, scan | Counts/s | The number of calls per second for key-related commands, such as **DEL** and **EXISTS**. |'."\n" .'| Redis\\_String\\_Monitor | append, bitcount, bitop, decr, decrby, get, getbit, getrange, getset, incr, incrby, incrbyfloat, mget, mset, msetnx, psetex, set, setbit, setex, setnx, setrange, strlen | Counts/s | The number of calls per second for String-related commands, such as **APPEND** and **MGET**. |'."\n" .'| Redis\\_Hashes\\_Monitor | hdel, hexists, hget, hgetall, hincrby, hincrbyfloat, hkeys, hlen, hmget, hmset, hset, hsetnx, hvals, hscan | Counts/s | The number of calls per second for Hash-related commands, such as **HGET** and **HDEL**. |'."\n" .'| Redis\\_Lists\\_Monitor | blpop, brpop, brpoplpush, lindex, linsert, llen, lpop, lpush, lpushx, lrange, lrem, lset, ltrim, rpop, rpoplpush, rpush, rpushx | Counts/s | The number of calls per second for List-related commands, such as **BLPOP** and **BRPOP**. |'."\n" .'| Redis\\_Sets\\_Monitor | sadd, scard, sdiff, sdiffstore, sinter, sinterstore, sismember, smembers, smove, spop, srandmember, srem, sunion, sunionstore, sscan | Counts/s | The number of calls per second for Set-related commands, such as **SADD** and **SCARD**. |'."\n" .'| Redis\\_Zset\\_Monitor | zadd, zcard, zcount, zincrby, zrange, zrangebyscore, zrank, zrem, zremrangebyrank, zremrangebyscore, zrevrange, zrevrangebyscore, zrevrank, zscore, zunionstore, zinterstore, zscan, zrangebylex, zlexcount, zremrangebylex, zpopmin, zpopmax, bzpopmin, bzpopmax | Counts/s | The number of calls per second for Sorted Set-related commands, such as **ZADD** and **ZCARD**. |'."\n" .'| Redis\\_Hyperlog\\_Monitor | pfadd, pfcount, pfmerge | Counts/s | The number of calls per second for HyperLogLog-related commands, such as **PFADD** and **PFCOUNT**. |'."\n" .'| Redis\\_Pub\\_Sub\\_Monitor | psubscribe, publish, pubsub, punsubscribe, subscribe, unsubscribe | Counts/s | The number of calls per second for publish/subscribe-related commands, such as **PUBLISH** and **SUBSCRIBE**. |'."\n" .'| Redis\\_Transaction\\_Monitor | discard, exec, multi, unwatch, watch | Counts/s | The number of calls per second for transaction-related commands, such as **WATCH** and **MULTI**. |'."\n" .'| Redis\\_Scripting\\_Monitor | eval, evalsha, script | Counts/s | The number of calls per second for scripting-related commands, such as **EVAL** and **EVALSHA**. |'."\n" .'| Calls\\_Monitor | flushall\\_calls, flushdb\\_calls, keys\\_calls | Counts | The cumulative number of calls for the **FLUSHALL**, **FLUSHDB**, and **KEYS** commands. |'."\n" .'| Redis\\_Connection\\_Monitor | auth, echo, ping, quit, select | Counts/s | The number of calls per second for connection-related commands, such as **AUTH** and **ECHO**. |'."\n" .'| Redis\\_Server\\_Monitor | bgsave, client, command, config, dbsize, debug, flushall, flushdb, info, monitor, slowlog, time | Counts/s | The number of calls per second for server-related commands, such as **BGSAVE** and **CONFIG**. |'."\n" .'| *Redis\\_Geo\\_Monitor* | geoadd, geohash, geopos, geodist, georadius, georadiusbymember | Counts/s | The number of calls per second for Geo-related commands, such as **GEOADD** and **GEOHASH**. |'."\n" .'| *Redis\\_Streams\\_Monitor* | xinfo, xadd, xtrim, xdel, xrange, xrevrange, xlen, xread, xgroup, xreadgroup, xack, xclaim, xpending | Counts/s | The number of calls per second for Streams-related commands, such as **XINFO** and **XADD**. |'."\n" .'| **** | | Counts/s | The number of calls per second for Lua script-related commands, such as EVAL and SCRIPT. |'."\n" .'| Redis\\_TairDoc\\_Monitor | jsondel, jsonget, jsonmget, jsonset, jsontype, jsonnumincrby, jsonstrappend, jsonstrlen, jsonarrappend, jsonarrpop, jsonarrinsert, jsonarrlen, jsonarrtrim | Counts/s | The number of calls per second for Doc-related commands, such as **JSON.SET** and **JSON.GET**. |'."\n" .'| Redis\\_TairHash\\_Monitor | exhset, exhsetnx, exhmset, exhexpireat, exhexpire, exhmsetwithopts, exhpexpireat, exhpexpire, exhpttl, exhttl, exhver, exhsetver, exhincrby, exhincrbyfloat, exhget, exhgetwithver, exhmget, exhdel, exhlen, exhexists, exhkeys, exhvals, exhgetall, exhmgetwithver, exhsterlen, exhscan | Counts/s | The number of calls per second for exHash-related commands, such as **EXHSET** and **EXHMSET**. |'."\n" .'| Redis\\_TairString\\_Monitor | cas, cad, exset, exget, exsetver, exincrby, exincrbyfloat, excas, excad | Counts/s | The number of calls per second for exString-related commands, such as **EXSET** and **EXGET**. |'."\n" .'| Redis\\_TairGis\\_Monitor | gisadd, gisget, gisdel, gissearch, giscontains, gisintersects, gisgetall | Counts/s | The number of calls per second for GIS-related commands, such as **GIS.ADD**, **GIS.GET**, and **GIS.DEL**. |'."\n" .'| Redis\\_TairBloom\\_Monitor | bfadd, bfmadd, bfexists, bfmexists, bfinsert, bfreserve, bfdebug | Counts/s | The number of calls per second for Bloom-related commands, such as **BF.RESERVE** and **BF.ADD**. |'."\n" ."\n" .'
', 'changeSet' => [ ['createdAt' => '2025-07-03T09:09:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-05-08T15:39:14.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryMonitorValues'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeHistoryMonitorValues', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:ResourceTag', 'validationType' => 'always'], ['conditionKey' => 'kvstore:ResourceTag', 'validationType' => 'always'], ['conditionKey' => 'kvstore:ResourceTag', 'validationType' => 'always'], ['conditionKey' => 'kvstore:ResourceTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'extraInfo' => ' ', ], 'DescribeHistoryTasks' => [ 'summary' => 'Queries a list of tasks in the task center.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '134634', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 10 to 100. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => ['description' => 'Set the value to Instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Instance', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The task status. Valid values:'."\n" ."\n" .'* **Scheduled**'."\n" .'* **Running**'."\n" .'* **Succeed**'."\n" .'* **Failed**'."\n" .'* **Cancelling**'."\n" .'* **Canceled**'."\n" .'* **Waiting**'."\n" ."\n" .'> This parameter is empty by default, which indicates that tasks in all states are queried. Separate multiple states with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Scheduled', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. This parameter is empty by default, which indicates that you can specify an unlimited number of instance IDs. Separate multiple instance IDs with commas (,). You can specify up to 30 instance IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-uf62br2491p5l****'."\n", 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The task ID. This parameter is empty by default, which indicates that you can specify an unlimited number of task IDs. Separate multiple task IDs with commas (,). You can specify up to 30 task IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 't-83br18hloy3faf****'."\n", 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => ['description' => 'The task type. This parameter is empty by default, which indicates that you can specify an unlimited number of task types.'."\n" ."\n" .'* **ModifyInsSpec**'."\n" .'* **DeleteInsNode**'."\n" .'* **AddInsNode**'."\n" .'* **HaSwitch**'."\n" .'* **RestartIns**'."\n" .'* **CreateIns**'."\n" .'* **ModifyInsConfig**'."\n" ."\n" .'> Separate multiple task types with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'ModifyInsSpec', 'title' => ''], ], [ 'name' => 'FromStartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The start time can be up to 30 days earlier than the current time.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-01-02T11:31:03Z', 'title' => ''], ], [ 'name' => 'ToStartTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Only tasks that have a start time earlier than or equal to the time specified by this parameter are queried.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-02-02T11:31:03Z', 'title' => ''], ], [ 'name' => 'FromExecTime', 'in' => 'query', 'schema' => ['description' => 'The minimum execution duration of a task. This parameter is used to filter tasks whose execution duration is longer than the minimum execution duration. Unit: seconds. The default value is 0, which indicates that no limit is imposed.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'ToExecTime', 'in' => 'query', 'schema' => ['description' => 'The maximum execution duration of a task. This parameter is used to filter tasks whose execution duration is shorter than or equal to the maximum execution duration. Unit: seconds. The default value is 0, which indicates that no limit is imposed.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], 'PageSize' => ['description' => 'The maximum number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of tasks that meet these constraints without taking pagination into account.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'Items' => [ 'description' => 'The queried task objects.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The task status.'."\n" ."\n" .'* **Scheduled**'."\n" .'* **Running**'."\n" .'* **Succeed**'."\n" .'* **Failed**'."\n" .'* **Cancelling**'."\n" .'* **Canceled**'."\n" .'* **Waiting**'."\n", 'type' => 'string', 'format' => 'int32', 'example' => 'Running', 'title' => ''], 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 't-83br18hloy3faf****', 'title' => ''], 'CurrentStepName' => ['description' => 'The name of the current step. If this parameter is left empty, the task is not started.'."\n", 'type' => 'string', 'example' => 'exec_task', 'title' => ''], 'StartTime' => ['description' => 'The start time of the task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-02-03T11:31:03Z', 'title' => ''], 'EndTime' => ['description' => 'The end time of the task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-02-03T12:06:17Z', 'title' => ''], 'TaskType' => ['description' => 'The task type.'."\n" ."\n" .'* **ModifyInsSpec**'."\n" .'* **DeleteInsNode**'."\n" .'* **AddInsNode**'."\n" .'* **HaSwitch**'."\n" .'* **RestartIns**'."\n" .'* **CreateIns**'."\n" .'* **ModifyInsConfig**'."\n", 'type' => 'string', 'example' => 'ModifyInsSpec', 'title' => ''], 'RemainTime' => ['description' => 'The estimated amount of time remaining to complete the task. Unit: seconds. A value of 0 indicates that the task is completed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], 'Progress' => ['description' => 'The task progress. Valid values: 0 to 100.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '79.0', 'title' => ''], 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], 'InstanceType' => ['description' => 'The instance type. The return value is Instance.'."\n", 'type' => 'string', 'example' => 'Instance', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'InstanceName' => ['description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'dba-tair-test-qcloud', 'title' => ''], 'DbType' => ['description' => 'The database type. The return value is redis.'."\n", 'type' => 'string', 'example' => 'redis', 'title' => ''], 'Product' => ['description' => 'The product. The return value is kvstore.'."\n", 'type' => 'string', 'example' => 'kvstore', 'title' => ''], 'TaskDetail' => ['description' => 'The task details. The details vary based on the task type.'."\n", 'type' => 'string', 'example' => '{\\"callerUid\\":\\"test\\"}', 'title' => ''], 'ReasonCode' => ['description' => 'The reason why the current task was initiated.'."\n", 'type' => 'string', 'example' => '小版本升级', 'title' => ''], 'ActionInfo' => ['description' => 'A set of allowed actions that can be taken on the task. The system matches the current step name and status of the task to the available actions specified by ActionInfo. If no matching action is found, the current status of the task does not support any action. Example:'."\n" ."\n" .' {"steps": ['."\n" .' {'."\n" .' "step_name": "exec_task", // The name of the step, which matches CurrentStepName.'."\n" .' "action_info": { // The actions supported for this step.'."\n" .' "Waiting": [ // The status, which matches Status.'."\n" .' "modifySwitchTime" // The action. Multiple actions are supported.'."\n" .' ]'."\n" .' }'."\n" .' },'."\n" .' {'."\n" .' "step_name": "init_task", // The name of the step.'."\n" .' "action_info": { // The actions supported for this step.'."\n" .' "Running": [ // The status.'."\n" .' "cancel", // The action.'."\n" .' "pause"'."\n" .' ]'."\n" .' }'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" ."\n" .'The system may support the following actions:'."\n" ."\n" .'* **retry**'."\n" .'* **cancel**'."\n" .'* **modifySwitchTime**: changes the switching or restoration time.'."\n", 'type' => 'string', 'example' => '{"steps":[{"action_info":{"Waiting":["modifySwitchTime"]},"step_name":"exec_task"}]}', 'title' => ''], 'Uid' => ['description' => 'The ID of the user to which the resources belong.'."\n", 'type' => 'string', 'example' => '141345906006****', 'title' => ''], 'CallerSource' => ['description' => 'The ID of the user who made the request. If CallerSource is set to User, CallerUid indicates the unique ID (UID) of the user.'."\n", 'type' => 'string', 'example' => '141345906006****', 'title' => ''], 'CallerUid' => ['description' => 'The request source. Valid values:'."\n" ."\n" .'* **System**'."\n" .'* **User**'."\n", 'type' => 'string', 'example' => 'User', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', 'description' => ''], ['errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 5,\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"TaskId\\": \\"t-83br18hloy3faf****\\",\\n \\"CurrentStepName\\": \\"exec_task\\",\\n \\"StartTime\\": \\"2022-02-03T11:31:03Z\\",\\n \\"EndTime\\": \\"2022-02-03T12:06:17Z\\",\\n \\"TaskType\\": \\"ModifyInsSpec\\",\\n \\"RemainTime\\": 1000,\\n \\"Progress\\": 79,\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"InstanceType\\": \\"Instance\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"InstanceName\\": \\"dba-tair-test-qcloud\\",\\n \\"DbType\\": \\"redis\\",\\n \\"Product\\": \\"kvstore\\",\\n \\"TaskDetail\\": \\"{\\\\\\\\\\\\\\"callerUid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\"}\\",\\n \\"ReasonCode\\": \\"小版本升级\\",\\n \\"ActionInfo\\": \\"{\\\\\\"steps\\\\\\":[{\\\\\\"action_info\\\\\\":{\\\\\\"Waiting\\\\\\":[\\\\\\"modifySwitchTime\\\\\\"]},\\\\\\"step_name\\\\\\":\\\\\\"exec_task\\\\\\"}]}\\",\\n \\"Uid\\": \\"141345906006****\\",\\n \\"CallerSource\\": \\"141345906006****\\",\\n \\"CallerUid\\": \\"User\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeHistoryTasks', 'changeSet' => [ ['createdAt' => '2025-04-01T08:30:02.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryTasks'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeHistoryTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeHistoryTasksStat' => [ 'summary' => 'Queries the task statistics in the task center.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '134639', 'abilityTreeNodes' => ['FEATUREkvstoreAO067M'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The region ID of the pending event. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The task status. Valid values:'."\n" ."\n" .'* **Scheduled**'."\n" .'* **Running**'."\n" .'* **Succeed**'."\n" .'* **Failed**'."\n" .'* **Cancelling**'."\n" .'* **Canceled**'."\n" .'* **Waiting**'."\n" ."\n" .'> This parameter is empty by default, which indicates that tasks in all states are queried. Separate multiple states with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Scheduled', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The task IDs. You can specify this parameter to query specific tasks. This parameter is empty by default, which indicates that all tasks are queried. Separate multiple task IDs with commas (,). You can specify up to 30 task IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 't-0mq1yyhm3ffl2bxxxx', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => ['description' => 'The type of the task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], ], [ 'name' => 'FromStartTime', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The beginning of the time range to query. The time must be in UTC and formatted as *yyyy-MM-dd*t*hh:mm*Z.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-01-02T11:31:03Z', 'title' => ''], ], [ 'name' => 'ToStartTime', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The end of the time range to query. The time must be in UTC and formatted as *yyyy-MM-dd*t*hh:mm*Z.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-02-02T11:31:03Z', 'title' => ''], ], [ 'name' => 'FromExecTime', 'in' => 'query', 'schema' => ['description' => 'The minimum execution duration of a task. This parameter is used to filter tasks whose execution duration is longer than the minimum execution duration. Unit: seconds. Default value: 0. This value indicates that the minimum execution duration is unlimited.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'ToExecTime', 'in' => 'query', 'schema' => ['description' => 'Maximum task execution time. This parameter is used to filter tasks whose execution duration is shorter than or equal to the maximum execution duration. Unit: seconds. Default value: 0. This value indicates that the minimum execution duration is unlimited.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABAF95F6-35C1-4177-AF3A-70969EBD****', 'title' => ''], 'Items' => [ 'description' => 'The task list.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tasks.'."\n", 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The task state.'."\n" ."\n" .'* **Scheduled**'."\n" .'* **Running**'."\n" .'* **Succeed**'."\n" .'* **Failed**'."\n" .'* **Cancelling**'."\n" .'* **Canceled**'."\n" .'* **Waiting**'."\n", 'type' => 'string', 'example' => 'Scheduled', 'title' => ''], 'TotalCount' => ['description' => 'The total number of tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', 'description' => ''], ['errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', 'description' => ''], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABAF95F6-35C1-4177-AF3A-70969EBD****\\",\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"Scheduled\\",\\n \\"TotalCount\\": 10\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeHistoryTasksStat', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHistoryTasksStat'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeHistoryTasksStat', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeInstanceAttribute' => [ 'summary' => 'Retrieves the details of a Tair (Redis-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56403', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CA40C261-EB72-4EDA-AC57-958722162595', 'title' => ''], 'Instances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceAttribute' => [ 'description' => 'The details of the instance.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''], 'PrivateIp' => ['description' => 'The private IP address of the instance.'."\n" ."\n" .'> This parameter is not returned if the network type of the instance is classic network.', 'type' => 'string', 'example' => '172.16.49.***', 'title' => ''], 'Capacity' => ['description' => 'The memory capacity of the instance. Unit: MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], 'CreateTime' => ['description' => 'The time when the instance was created. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2019-03-06T10:42:03Z', 'title' => ''], 'ConnectionDomain' => ['description' => 'The internal endpoint of the instance.', 'type' => 'string', 'example' => 'r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com', 'title' => ''], 'IsRds' => ['description' => 'Indicates whether the instance is managed by RDS. Valid values:'."\n" ."\n" .'- **true**: The instance is managed by RDS.'."\n" ."\n" .'- **false**: The instance is not managed by RDS.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ChargeType' => ['description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'- **PrePaid**: subscription'."\n" ."\n" .'- **PostPaid**: pay-as-you-go', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''], 'StorageType' => ['description' => 'The storage type.', 'type' => 'string', 'example' => 'essd_pl1', 'title' => ''], 'VpcAuthMode' => ['description' => 'The authentication mode for the instance that is deployed in a VPC. Valid values:'."\n" ."\n" .'- **Open**: Password authentication is enabled.'."\n" ."\n" .'- **Close**: Password-free access is enabled.', 'type' => 'string', 'example' => 'Open', 'title' => ''], 'ArchitectureType' => ['description' => 'The architecture of the instance. Valid values:'."\n" ."\n" .'- **cluster**: The instance is a cluster instance.'."\n" ."\n" .'- **standard**: The instance is a standard instance.'."\n" ."\n" .'- **rwsplit**: The instance is a read/write splitting instance.', 'type' => 'string', 'example' => 'standard', 'title' => ''], 'AvailabilityValue' => ['description' => 'The availability metric of the instance in the current month.', 'type' => 'string', 'example' => '100%', 'title' => ''], 'NetworkType' => ['description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'- **CLASSIC**: classic network'."\n" ."\n" .'- **VPC**: VPC', 'type' => 'string', 'example' => 'CLASSIC', 'title' => ''], 'Port' => ['description' => 'The service port of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '6379', 'title' => ''], 'SecondaryZoneId' => ['description' => 'The ID of the secondary zone.'."\n" ."\n" .'> If the instance is not deployed in a secondary zone, this parameter is not returned.', 'type' => 'string', 'example' => 'cn-hongkong-h', 'title' => ''], 'PackageType' => ['description' => 'The edition of the instance. Valid values:'."\n" ."\n" .'- **standard**: standard edition'."\n" ."\n" .'- **customized**: The customized edition is discontinued.', 'type' => 'string', 'example' => 'standard', 'title' => ''], 'EngineVersion' => ['description' => 'The database engine version of the instance. Valid values: **2.8**, **4.0**, **5.0**, **6.0**, and **7.0**.', 'type' => 'string', 'example' => '4.0', 'title' => ''], 'Config' => ['description' => 'The parameter settings of the instance. The settings are in the JSON format. For more information, see [Parameters](~~43885~~).'."\n" .'To view the audit log configuration, call the [DescribeAuditLogConfig](~~473830~~) operation.', 'type' => 'string', 'example' => '{\\"EvictionPolicy\\":\\"volatile-lru\\",\\"hash-max-ziplist-entries\\":512,\\"zset-max-ziplist-entries\\":128,\\"zset-max-ziplist-value\\":64,\\"set-max-intset-entries\\":512,\\"hash-max-ziplist-value\\":64}', 'title' => ''], 'VpcCloudInstanceId' => ['description' => 'The ID of the instance that is deployed in a VPC.', 'type' => 'string', 'example' => 'r-bp1d72gwl41z7f****', 'title' => ''], 'Bandwidth' => ['description' => 'The bandwidth of the instance. Unit: Mbit/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'apitest', 'title' => ''], 'SecurityIPList' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], 'ShardCount' => ['description' => 'The number of shards.'."\n" ."\n" .''."\n" ."\n" .'This parameter is returned only if the instance is a cloud-native instance that uses the cluster architecture and is available on the China site (aliyun.com).'."\n" ."\n" .'', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'ReplicaCount' => ['description' => 'The number of replica nodes in the primary zone.'."\n" ."\n" .'> The **ReplicaCount** and **SlaveReplicaCount** parameters are returned only for cloud-native instances. If the instance uses the cluster architecture, these parameters specify the number of replica nodes per **shard** in the primary and secondary zones.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SlaveReplicaCount' => ['description' => 'The number of replica nodes in the secondary zone.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ReadOnlyCount' => ['description' => 'The number of read-only nodes in the primary zone.'."\n" ."\n" .'> The **ReadOnlyCount** and **SlaveReadOnlyCount** parameters are returned only for cloud-native instances for which read/write splitting is enabled. If the instance uses the cluster architecture, these parameters specify the number of read-only nodes per **shard** in the primary and secondary zones.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'SlaveReadOnlyCount' => ['description' => 'The number of read-only nodes in the secondary zone. This parameter is returned only when read/write splitting is enabled for an instance that is deployed in multiple zones.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'GlobalInstanceId' => ['description' => 'The ID of the distributed instance.'."\n" ."\n" .'> This parameter is returned only for child instances of a distributed instance.', 'type' => 'string', 'example' => 'gr-bp14rkqrhac****', 'title' => ''], 'QPS' => ['description' => 'The maximum queries per second (QPS).', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''], 'AuditLogRetention' => ['description' => 'The retention period of the audit log. Unit: days. A value of 0 indicates that the audit log feature is disabled. For more information about how to enable the audit log feature, see [Enable audit logging](~~102015~~).', 'type' => 'string', 'example' => '15', 'title' => ''], 'ZoneType' => ['description' => 'The zone type of the instance. Valid values:'."\n" ."\n" .'- **singlezone**: single-zone'."\n" ."\n" .'- **doublezone**: multi-zone', 'type' => 'string', 'example' => 'singlezone', 'title' => ''], 'MaintainStartTime' => ['description' => 'The start time of the maintenance window. The time is in the *HH:mmZ* format and is displayed in UTC.', 'type' => 'string', 'example' => '18:00Z', 'title' => ''], 'MaintainEndTime' => ['description' => 'The end time of the maintenance window. The time is in the *HH:mmZ* format and is displayed in UTC.', 'type' => 'string', 'example' => '22:00Z', 'title' => ''], 'InstanceClass' => ['description' => 'The instance type. For more information, see [Instance types](~~107984~~).', 'type' => 'string', 'example' => 'redis.master.small.default', 'title' => ''], 'RealInstanceClass' => ['description' => 'If the instance is a cloud-native cluster instance, this parameter indicates the actual instance type of the shards. In this case, the InstanceClass parameter indicates a virtual instance type.'."\n" ."\n" .'> To query the fees for an instance of this instance type, specify the value of this parameter in the [DescribePrice](~~473807~~) operation.', 'type' => 'string', 'example' => 'tair.rdb.with.proxy.1g', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'r-bp1d72gwl41z7f****', 'title' => ''], 'InstanceType' => ['description' => 'The database engine. Valid values:'."\n" ."\n" .'- **Tair**'."\n" ."\n" .'- **Redis**: ApsaraDB for Redis Community Edition instances and classic ApsaraDB for Redis Enhanced Edition (Tair) memory-type instances are of the Redis database engine.'."\n" ."\n" .'- **Memcache**', 'type' => 'string', 'example' => 'Redis', 'title' => ''], 'HasRenewChangeOrder' => ['description' => 'Indicates whether a pending order for renewal or configuration change exists for the instance. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'string', 'example' => 'false', 'title' => ''], 'InstanceReleaseProtection' => ['description' => 'Indicates whether release protection is enabled for the instance. Valid values:'."\n" ."\n" .'- **true**: Release protection is enabled.'."\n" ."\n" .'- **false**: Release protection is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ReplicationMode' => ['description' => 'The replication architecture. Valid values:'."\n" ."\n" .'- **master-slave**: master-replica architecture'."\n" ."\n" .'- **cluster**: cluster architecture, which includes read/write splitting and cluster instances'."\n" ."\n" .'- **db**: cloud-native sharded cluster architecture', 'type' => 'string', 'example' => 'master-slave', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'EndTime' => ['description' => 'The expiration time of the subscription instance. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.', 'type' => 'string', 'example' => '2019-04-06T10:42:03Z', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], 'ReplicaId' => ['description' => 'The ID of the replica node.', 'type' => 'string', 'example' => 'bls-awxxxxxxxxxxxxx', 'title' => ''], 'NodeType' => ['description' => 'The node type. Valid values:'."\n" ."\n" .'- **double**: The instance has two data nodes.'."\n" ."\n" .'- **single**: The instance has a single data node.'."\n" ."\n" .'- **readone**: The read/write splitting instance has one read-only node.'."\n" ."\n" .'- **readthree**: The read/write splitting instance has three read-only nodes.', 'type' => 'string', 'example' => 'double', 'title' => ''], 'Connections' => ['description' => 'The maximum number of connections.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], 'BackupLogStartTime' => ['description' => 'The earliest point in time to which data can be restored. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.'."\n" ."\n" .'> - This parameter is returned only if the [Data Flashback](~~148479~~) feature is enabled for the instance.'."\n" .'>'."\n" .'> - When you call the [RestoreInstance](~~473824~~) operation to perform a data flashback, this is the earliest value that can be specified for the **RestoreTime** parameter.', 'type' => 'string', 'example' => '2021-07-06T05:49:55Z', 'title' => ''], 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hongkong-b', 'title' => ''], 'InstanceStatus' => ['description' => 'The state of the instance. Valid values:'."\n" ."\n" .'- **Normal**: The instance is running as expected.'."\n" ."\n" .'- **Creating**: The instance is being created.'."\n" ."\n" .'- **Changing**: The instance configuration is being changed.'."\n" ."\n" .'- **Inactive**: The instance is disabled.'."\n" ."\n" .'- **Flushing**: The instance is being released.'."\n" ."\n" .'- **Released**: The instance is released.'."\n" ."\n" .'- **Transforming**: The billing method of the instance is being changed.'."\n" ."\n" .'- **Migrating**: The instance is being migrated.'."\n" ."\n" .'- **BackupRecovering**: The instance is being restored from a backup.'."\n" ."\n" .'- **MinorVersionUpgrading**: The minor version of the instance is being updated.'."\n" ."\n" .'- **NetworkModifying**: The network type of the instance is being changed.'."\n" ."\n" .'- **SSLModifying**: The SSL certificate of the instance is being changed.'."\n" ."\n" .'- **MajorVersionUpgrading**: The major version of the instance is being upgraded. The instance remains accessible during the upgrade.'."\n" ."\n" .'> For more information about instance states and their impacts, see [Instance states](~~200740~~).', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'Engine' => ['description' => 'The database engine. The value is fixed as **Redis**.', 'type' => 'string', 'example' => 'Redis', 'title' => ''], 'Storage' => ['description' => 'The storage space of an ApsaraDB for Redis Enhanced Edition (Tair) instance that uses enhanced SSDs (ESSDs).', 'type' => 'string', 'example' => '50', 'title' => ''], 'CloudType' => ['description' => 'This parameter is returned only for ApsaraDB for Redis instances that are created in Alibaba Cloud clouds.', 'type' => 'string', 'example' => 'cloudbox', 'title' => ''], 'IsOrderCompleted' => ['description' => 'Indicates whether a configuration change is complete. Valid values:'."\n" ."\n" .'- **true**: The configuration change is complete, or no configuration change is in progress.'."\n" ."\n" .'- **false**: The configuration change is in progress.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'IsSupportTDE' => ['description' => 'Indicates whether Transparent Data Encryption (TDE) is supported. Valid values:'."\n" ."\n" .'- **true**: TDE is supported. This feature is supported only for ApsaraDB for Redis Enhanced Edition (Tair) memory-type instances.'."\n" ."\n" .'- **false**: TDE is not supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The tags.', 'type' => 'array', 'items' => [ 'description' => 'The tag.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'tagkey', 'title' => ''], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'tagvalue', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'AutoSecondaryZone' => ['description' => 'Indicates whether the secondary zone is automatically selected. Valid values:'."\n" ."\n" .'- **true**: The secondary zone is automatically selected.'."\n" ."\n" .'- **false**: The secondary zone is not automatically selected.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ComputingType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CA40C261-EB72-4EDA-AC57-958722162595\\",\\n \\"Instances\\": {\\n \\"DBInstanceAttribute\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1nme44gek34slfc****\\",\\n \\"PrivateIp\\": \\"172.16.49.***\\",\\n \\"Capacity\\": 1024,\\n \\"CreateTime\\": \\"2019-03-06T10:42:03Z\\",\\n \\"ConnectionDomain\\": \\"r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com\\",\\n \\"IsRds\\": true,\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"StorageType\\": \\"essd_pl1\\",\\n \\"VpcAuthMode\\": \\"Open\\",\\n \\"ArchitectureType\\": \\"standard\\",\\n \\"AvailabilityValue\\": \\"100%\\",\\n \\"NetworkType\\": \\"CLASSIC\\",\\n \\"Port\\": 6379,\\n \\"SecondaryZoneId\\": \\"cn-hongkong-h\\",\\n \\"PackageType\\": \\"standard\\",\\n \\"EngineVersion\\": \\"4.0\\",\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"EvictionPolicy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"volatile-lru\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hash-max-ziplist-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"zset-max-ziplist-entries\\\\\\\\\\\\\\":128,\\\\\\\\\\\\\\"zset-max-ziplist-value\\\\\\\\\\\\\\":64,\\\\\\\\\\\\\\"set-max-intset-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"hash-max-ziplist-value\\\\\\\\\\\\\\":64}\\",\\n \\"VpcCloudInstanceId\\": \\"r-bp1d72gwl41z7f****\\",\\n \\"Bandwidth\\": 10,\\n \\"InstanceName\\": \\"apitest\\",\\n \\"SecurityIPList\\": \\"127.0.0.1\\",\\n \\"ShardCount\\": 2,\\n \\"ReplicaCount\\": 1,\\n \\"SlaveReplicaCount\\": 1,\\n \\"ReadOnlyCount\\": 5,\\n \\"SlaveReadOnlyCount\\": 2,\\n \\"GlobalInstanceId\\": \\"gr-bp14rkqrhac****\\",\\n \\"QPS\\": 100000,\\n \\"AuditLogRetention\\": \\"15\\",\\n \\"ZoneType\\": \\"singlezone\\",\\n \\"MaintainStartTime\\": \\"18:00Z\\",\\n \\"MaintainEndTime\\": \\"22:00Z\\",\\n \\"InstanceClass\\": \\"redis.master.small.default\\",\\n \\"RealInstanceClass\\": \\"tair.rdb.with.proxy.1g\\",\\n \\"InstanceId\\": \\"r-bp1d72gwl41z7f****\\",\\n \\"InstanceType\\": \\"Redis\\",\\n \\"HasRenewChangeOrder\\": \\"false\\",\\n \\"InstanceReleaseProtection\\": false,\\n \\"ReplicationMode\\": \\"master-slave\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"EndTime\\": \\"2019-04-06T10:42:03Z\\",\\n \\"VSwitchId\\": \\"vsw-bp1e7clcw529l773d****\\",\\n \\"ReplicaId\\": \\"bls-awxxxxxxxxxxxxx\\",\\n \\"NodeType\\": \\"double\\",\\n \\"Connections\\": 10000,\\n \\"BackupLogStartTime\\": \\"2021-07-06T05:49:55Z\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"ZoneId\\": \\"cn-hongkong-b\\",\\n \\"InstanceStatus\\": \\"Normal\\",\\n \\"Engine\\": \\"Redis\\",\\n \\"Storage\\": \\"50\\",\\n \\"CloudType\\": \\"cloudbox\\",\\n \\"IsOrderCompleted\\": true,\\n \\"IsSupportTDE\\": true,\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tagkey\\",\\n \\"Value\\": \\"tagvalue\\"\\n }\\n ]\\n },\\n \\"AutoSecondaryZone\\": true,\\n \\"ComputingType\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeInstanceAttribute', 'changeSet' => [ ['createdAt' => '2025-11-12T11:08:10.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-02-18T06:22:39.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-10-09T05:56:54.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-12-27T03:33:34.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-10-13T03:15:22.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-08T13:10:47.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-02T12:40:53.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-14T12:04:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-03-07T08:03:28.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceAttribute'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeInstanceAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeInstanceAutoRenewalAttribute' => [ 'summary' => 'Queries whether auto-renewal is enabled for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n" ."\n" .'> By default, the system checks whether auto-renewal is enabled for all instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values: **30**, **50**, and **100**.'."\n" ."\n" .'> The default value is **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '30', 'example' => '30', 'default' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. The value must be an integer greater than **0**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2B17D708-1D6D-49F3-B6D7-478371DD****', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Item' => [ 'description' => 'Details of the auto-renewal information for the instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'The auto-renewal period. Unit: months.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'DBInstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'AutoRenew' => ['description' => 'Indicates whether auto-renewal is enabled. Valid values:'."\n" ."\n" .'* **true**: Auto-renewal is enabled.'."\n" .'* **false**: Auto-renewal is disabled.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'RegionId' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IllegalParameter', 'errorMessage' => 'Specified parameter exceeds range.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2B17D708-1D6D-49F3-B6D7-478371DD****\\",\\n \\"PageNumber\\": 1,\\n \\"PageRecordCount\\": 30,\\n \\"TotalRecordCount\\": 1,\\n \\"Items\\": {\\n \\"Item\\": [\\n {\\n \\"Duration\\": 1,\\n \\"DBInstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"AutoRenew\\": \\"true\\",\\n \\"RegionId\\": \\"cn-shanghai\\"\\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":"\\n \\n \\n 1\\n cn-shanghai\\n r-bp1zxszhcgatnx****\\n true\\n \\n \\n 1\\n 1\\n 2B17D708-1D6D-49F3-B6D7-478371DDDBE8\\n 1\\n","errorExample":"\\n \\n \\n 1\\n cn-shanghai\\n r-xxxxxxxxxxxxxxx\\n true\\n \\n \\n 1\\n 1\\n 2B17D708-1D6D-49F3-B6D7-478371DDDBE8\\n 1\\n"}]', 'title' => 'DescribeInstanceAutoRenewalAttribute', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceAutoRenewalAttribute'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeInstanceAutoRenewalAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeInstanceConfig' => [ 'summary' => 'Queries some of the default configuration parameters for a Tair (Redis-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56407', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. You can call the [DescribeInstances](~~473778~~) operation to obtain this ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Config' => ['description' => 'The default configuration parameters of the instance. To view the full list of parameters, call the [DescribeParameters](~~473847~~) operation.', 'type' => 'string', 'example' => '{\\"EvictionPolicy\\":\\"volatile-lru\\",\\"hash-max-ziplist-entries\\":512,\\"zset-max-ziplist-entries\\":128,\\"list-max-ziplist-entries\\":512,\\"list-max-ziplist-value\\":64,\\"zset-max-ziplist-value\\":64,\\"set-max-intset-entries\\":512,\\"hash-max-ziplist-value\\":64}', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4E2C08F6-2D11-4ECD-9A4C-27EF2D3D****', 'title' => ''], 'ParamReplMode' => ['description' => 'The replication mode. Valid values:'."\n" ."\n" .'- **async** (default): asynchronous mode'."\n" ."\n" .'- **semisync**: semi-synchronous mode', 'type' => 'string', 'example' => 'async', 'title' => ''], 'ParamReplTimeout' => ['description' => 'The degradation threshold for the semi-synchronous mode. This parameter is valid only in semi-synchronous mode. Unit: milliseconds. Valid values: 10 to 60000. Default value: 500.'."\n" ."\n" .'> If replication latency exceeds this threshold, the replication mode degrades to asynchronous mode. When the replication latency returns to normal, the mode reverts to semi-synchronous mode.', 'type' => 'string', 'example' => '500', 'title' => ''], 'ParamNoLooseSentinelEnabled' => ['description' => 'Specifies whether to enable Sentinel compatibility mode. This parameter applies only to non-cluster instances. Valid values:'."\n" ."\n" .'- **no** (default): Disabled'."\n" ."\n" .'- **yes**: Enabled'."\n" ."\n" .'> For more information, see [Sentinel compatibility mode](~~178911~~).', 'type' => 'string', 'example' => 'no', 'title' => ''], 'ParamSentinelCompatEnable' => ['description' => 'Specifies whether to enable Sentinel compatibility mode. This parameter applies to instances that use the cluster architecture with proxy connection mode or the read/write splitting architecture. Valid values:'."\n" ."\n" .'- **0** (default): Disabled'."\n" ."\n" .'- **1**: Enabled'."\n" ."\n" .'> For more information, see [Sentinel compatibility mode](~~178911~~).', 'type' => 'string', 'example' => '0', 'title' => ''], 'ParamNoLooseSentinelPasswordFreeAccess' => ['description' => 'Specifies whether to allow password-free execution of Sentinel commands when Sentinel compatibility mode is enabled. Valid values:'."\n" ."\n" .'- **no** (default): Disabled.'."\n" ."\n" .'- **yes**: Enabled. Allows you to run Sentinel commands on any connection without a password and use the `SENTINEL` command to subscribe to the `+switch-master` channel.', 'type' => 'string', 'example' => 'no', 'title' => ''], 'ParamNoLooseSentinelPasswordFreeCommands' => ['description' => 'Additional commands that can be run without a password. This parameter is valid only when Sentinel compatibility mode is enabled and `ParamNoLooseSentinelPasswordFreeAccess` is set to `yes`. By default, this parameter is empty.', 'type' => 'string', 'example' => '****', 'title' => ''], ], 'description' => 'The returned data.', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"EvictionPolicy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"volatile-lru\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hash-max-ziplist-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"zset-max-ziplist-entries\\\\\\\\\\\\\\":128,\\\\\\\\\\\\\\"list-max-ziplist-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"list-max-ziplist-value\\\\\\\\\\\\\\":64,\\\\\\\\\\\\\\"zset-max-ziplist-value\\\\\\\\\\\\\\":64,\\\\\\\\\\\\\\"set-max-intset-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"hash-max-ziplist-value\\\\\\\\\\\\\\":64}\\",\\n \\"RequestId\\": \\"4E2C08F6-2D11-4ECD-9A4C-27EF2D3D****\\",\\n \\"ParamReplMode\\": \\"async\\",\\n \\"ParamReplTimeout\\": \\"500\\",\\n \\"ParamNoLooseSentinelEnabled\\": \\"no\\",\\n \\"ParamSentinelCompatEnable\\": \\"0\\",\\n \\"ParamNoLooseSentinelPasswordFreeAccess\\": \\"no\\",\\n \\"ParamNoLooseSentinelPasswordFreeCommands\\": \\"****\\"\\n}","type":"json"}]', 'title' => 'DescribeInstanceConfig', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-12-11T07:48:01.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-12-03T02:42:02.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-11-05T14:48:25.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-05-08T09:40:55.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceConfig'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeInstanceConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeInstanceMultiVIP' => [ 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '267594', 'abilityTreeNodes' => ['FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'ABAF95F6-35C1-4177-AF3A-70969EBD****'], 'MasterDnsRecord' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'example' => '172.21.210.***', 'title' => ''], 'description' => '', 'title' => '', 'example' => '', ], 'MultiVIPList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ConnectionString' => ['type' => 'string', 'description' => '', 'example' => 'r-bp1p4pzsr2rtubcvns-conn1.redis.rds.aliyuncs.com', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'title' => '', 'example' => '', ], 'MaxQuota' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '2', 'title' => ''], 'MasterDns' => ['type' => 'string', 'description' => '', 'example' => 'r-8vb30e8n0m4nvu7tff.redis.zhangbei.rds.aliyuncs.com', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'description' => '关于多LB，详情参见', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'kvstore:DescribeInstanceMultiVIP', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABAF95F6-35C1-4177-AF3A-70969EBD****\\",\\n \\"MasterDnsRecord\\": [\\n \\"172.21.210.***\\"\\n ],\\n \\"MultiVIPList\\": [\\n {\\n \\"ConnectionString\\": \\"r-bp1p4pzsr2rtubcvns-conn1.redis.rds.aliyuncs.com\\"\\n }\\n ],\\n \\"MaxQuota\\": 2,\\n \\"MasterDns\\": \\"r-8vb30e8n0m4nvu7tff.redis.zhangbei.rds.aliyuncs.com\\"\\n}","type":"json"}]', ], 'DescribeInstanceSSL' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56411', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '02260F96-913E-4655-9BA5-A3651CAF****', 'title' => ''], 'SSLEnabled' => ['description' => 'The status of the TLS (SSL) encryption feature. Valid values:'."\n" ."\n" .'* **Enable**: SSL encryption is enabled.'."\n" .'* **Disable**: SSL encryption is disabled.'."\n", 'type' => 'string', 'example' => 'Enable', 'title' => ''], 'SSLExpiredTime' => ['description' => 'The time when the CA certificate expires.'."\n", 'type' => 'string', 'example' => '2020-08-05T09:05:53Z', 'title' => ''], 'CertCommonName' => ['description' => 'The common name of the CA certificate. The default value is the internal endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', 'title' => ''], 'CertDownloadURL' => ['description' => 'The download URL of the CA certificate.'."\n", 'type' => 'string', 'example' => 'https://apsaradb-public.oss-ap-sout****-1.aliy****.com/ApsaraDB-CA-Chain.zip', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRedisVersionPattern', 'errorMessage' => 'Redis db or proxy version does not match specified pattern.', 'description' => ''], ], 403 => [ ['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' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The InstanceId provided does not exist in our records.', 'description' => ''], ], ], 'title' => 'DescribeInstanceSSL', 'summary' => 'Queries whether TLS (SSL) encryption is enabled for a Tair (Redis OSS-compatible) instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-08-16T03:19:49.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-04-11T05:54:40.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceSSL'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeInstanceSSL', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"RequestId\\": \\"02260F96-913E-4655-9BA5-A3651CAF****\\",\\n \\"SSLEnabled\\": \\"Enable\\",\\n \\"SSLExpiredTime\\": \\"2020-08-05T09:05:53Z\\",\\n \\"CertCommonName\\": \\"r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com\\",\\n \\"CertDownloadURL\\": \\"https://apsaradb-public.oss-ap-sout****-1.aliy****.com/ApsaraDB-CA-Chain.zip\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Enable\\n 2020-08-05T09:05:53Z\\n r-bp1zxszhcgatnx****\\n 02260F96-913E-4655-9BA5-A3651CAF****\\n r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com\\n","errorExample":""}]', 'description' => 'SSL encryption is supported for Tair (Redis OSS-compatible) 2.8 standard master-replica instances, Tair (Redis OSS-compatible) 2.8 master-replica cluster instances, and Tair (Redis OSS-compatible) 4.0 master-replica cluster instances. You can enable SSL encryption to enhance data transmission security.'."\n" ."\n" .'You can use one of the following methods to enable or disable SSL encryption or update the SSL certificate for a Tair (Redis OSS-compatible) instance:'."\n" ."\n" .'* Call the [ModifyInstanceSSL](~~473838~~) operation.'."\n" .'* Enable or disable SSL encryption or update the SSL certificate in the Tair (Redis OSS-compatible) console. For more information, see [Configure SSL encryption](~~84898~~).'."\n" ."\n" .'> After SSL encryption is enabled, the instance may respond slower.', ], 'DescribeInstanceTDEStatus' => [ 'summary' => 'Queries whether transparent data encryption (TDE) is enabled for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56412', 'abilityTreeNodes' => ['FEATUREkvstoreW1V0SW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Tair (Redis OSS-compatible) instance. You can call the [DescribeInstances](~~473778~~) operation to query instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TDEStatus' => ['description' => 'Indicates whether TDE is enabled. Valid values:'."\n" ."\n" .'* **Enabled**: TDE is enabled.'."\n" .'* **Disable**: TDE is disabled.'."\n", 'type' => 'string', 'example' => 'Enabled', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The InstanceId provided does not exist in our records.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"TDEStatus\\": \\"Enabled\\",\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Enabled\\n 5D622714-AEDD-4609-9167-F5DDD3D1****\\n","errorExample":""}]', 'title' => 'DescribeInstanceTDEStatus', 'description' => 'For more information about TDE and the usage notes of TDE, see [Enable TDE](~~265913~~).'."\n" ."\n" .'> You can call the [ModifyInstanceTDE](~~473859~~) to enable or disable TDE.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-08-16T03:19:50.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceTDEStatus'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeInstanceTDEStatus', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeInstances' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56409', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance.'."\n" ."\n" .'> When calling this API, if the **Tag** parameter is specified, this parameter is required.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the instances to query.'."\n" .'> To specify multiple instance IDs, separate them with commas (,). A maximum of 30 instance IDs can be specified in a single request.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'InstanceStatus', 'in' => 'query', 'schema' => ['description' => 'The status of the instance. Valid values:'."\n" .'* **Normal**: normal.'."\n" .'* **Creating**: being created.'."\n" .'* **Changing**: being changed.'."\n" .'* **Inactive**: disabled.'."\n" .'* **Flushing**: being flushed.'."\n" .'* **Released**: released.'."\n" .'* **Transforming**: being transformed.'."\n" .'* **Migrating**: being migrated.'."\n" .'* **BackupRecovering**: being restored from a backup.'."\n" .'* **MinorVersionUpgrading**: minor version being upgraded.'."\n" .'* **NetworkModifying**: network type being changed.'."\n" .'* **SSLModifying**: SSL being changed.'."\n" .'* **MajorVersionUpgrading**: major version being upgraded. The instance can be accessed normally.'."\n" ."\n" .'> For more information about instance statuses, see [Instance statuses and impacts](~~200740~~).', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method. Valid values:'."\n" .'* **PrePaid**: subscription.'."\n" .'* **PostPaid**: pay-as-you-go.', 'type' => 'string', 'required' => false, 'enum' => ['PrePaid', 'PostPaid'], 'example' => 'PostPaid', 'title' => '', ], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the instance. Valid values:'."\n" .'* **CLASSIC**: classic network.'."\n" .'* **VPC**: virtual private cloud (VPC).', 'type' => 'string', 'required' => false, 'enum' => ['CLASSIC', 'VPC'], 'example' => 'CLASSIC', 'title' => '', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The Redis-compatible engine version of the instance. Valid values: **2.8**, **4.0**, **5.0**, **6.0**, and **7.0**.', 'type' => 'string', 'required' => false, 'enum' => ['1.0', '2.8', '4.0', '5.0', '6.0', '7.0'], 'example' => '4.0', 'title' => '', ], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => ['description' => 'The instance type. For more information, see [Instance types](~~107984~~).', 'type' => 'string', 'required' => false, 'example' => 'redis.master.small.default', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number of the instance list. Pages start from **1**. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries per page. Maximum value: **50**. Default value: **30**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '0', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The category of the instance. Valid values:'."\n" .'* **Tair**: Tair (Enhanced Edition)'."\n" .'* **Redis**: ApsaraDB for Redis Community Edition'."\n" .'* **Memcache**', 'type' => 'string', 'required' => false, 'default' => 'Redis', 'enum' => ['Redis', 'Memcache', 'tair_essd', 'tair_scm', 'Tair', 'tair_rdb', 'tair_skv'], 'example' => 'Redis', 'title' => '', ], ], [ 'name' => 'SearchKey', 'in' => 'query', 'schema' => ['description' => 'The keyword used for fuzzy search by instance name or instance ID.', 'type' => 'string', 'required' => false, 'example' => 'apitest', 'title' => ''], ], [ 'name' => 'ArchitectureType', 'in' => 'query', 'schema' => ['description' => 'The architecture type. Valid values:'."\n" .'* **cluster**: cluster.'."\n" .'* **standard**: standard.'."\n" .'* **rwsplit**: read/write splitting.', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''], ], [ 'name' => 'Expired', 'in' => 'query', 'schema' => ['description' => 'The expiration status of the instance. Valid values:'."\n" ."\n" .'* **true**: expired.'."\n" .'* **false**: not expired.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong-b', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n" .'> You can call the [ListResourceGroups](~~158855~~) API or use the console to obtain the list of resource group IDs. For more information, see [View basic information of a resource group](~~151181~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], [ 'name' => 'GlobalInstance', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to filter child instances of distributed instances from the returned instance list. Valid values:'."\n" .'* **true**: returns only child instance information.'."\n" .'* **false**: does not return child instance information.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'EditionType', 'in' => 'query', 'schema' => [ 'description' => 'The edition of the instance. Valid values:'."\n" .'* **Community**: ApsaraDB for Redis Community Edition.'."\n" .'* **Enterprise**: Tair Enhanced Edition.', 'type' => 'string', 'required' => false, 'enum' => ['Enterprise', 'Community'], 'example' => 'Enterprise', 'title' => '', ], ], [ 'name' => 'PrivateIp', 'in' => 'query', 'schema' => ['description' => 'The private IP address of the VPC.', 'type' => 'string', 'required' => false, 'example' => '172.16.49.***', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags of the instance.', 'type' => 'array', 'items' => [ 'description' => 'Object.', 'type' => 'object', 'properties' => [ 'Value' => ['description' => 'The value of the tag. The tag value and key together form a key-value pair.', 'type' => 'string', 'required' => false, 'example' => '开发', 'title' => ''], 'Key' => ['description' => 'The key of the tag. The tag key and value together form a key-value pair.'."\n" .'> A maximum of 5 tag key-value pairs can be specified at a time.', 'type' => 'string', 'required' => false, 'example' => '存储类型', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => [ 'description' => 'The node type. Valid values:'."\n" .'* **MASTER_SLAVE**: high availability (dual-replica)'."\n" .'* **STAND_ALONE**: single replica'."\n" .'* **double**: dual-replica'."\n" .'* **single**: single replica'."\n" .'> For cloud-native instances, select **MASTER_SLAVE** or **STAND_ALONE**. For classic instances, select **double** or **single**.', 'type' => 'string', 'required' => false, 'enum' => ['STAND_ALONE', 'MASTER_SLAVE', 'double', 'single'], 'example' => 'MASTER_SLAVE', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1E83311F-0EE4-4922-A3BF-730B312B****', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the instance list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'TotalCount' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Instances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'KVStoreInstance' => [ 'description' => 'A collection of instances.', 'type' => 'array', 'items' => [ 'description' => 'Object.', 'type' => 'object', 'properties' => [ 'Connections' => ['description' => 'The maximum number of connections supported by the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', 'title' => ''], 'EndTime' => ['description' => 'The expiration time of a subscription instance.', 'type' => 'string', 'example' => '2019-06-13T16:00:00Z', 'title' => ''], 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], 'EditionType' => ['description' => 'The edition of the instance. Valid values:'."\n" .'- **Community**: Community Edition.'."\n" .'- **Enterprise**: Enhanced Edition.', 'type' => 'string', 'example' => 'Enterprise', 'title' => ''], 'Config' => ['description' => 'The parameter settings of the instance. For more information, see [Parameter settings](~~43885~~).', 'type' => 'string', 'example' => '{\\"maxmemory-policy\\":\\"volatile-lfu\\",\\"EvictionPolicy\\":\\"volatile-lru\\",\\"hash-max-ziplist-entries\\":512,\\"zset-max-ziplist-entries\\":128,\\"zset-max-ziplist-value\\":64,\\"set-max-intset-entries\\":512,\\"hash-max-ziplist-value\\":64,\\"#no_loose_disabled-commands\\":\\"flushall,flushdb\\",\\"lazyfree-lazy-eviction\\":\\"yes\\"}', 'title' => ''], 'Port' => ['description' => 'The service port of the instance.'."\n" .'>After the port of the network connection address is changed, this field cannot provide actual network status information of the instance. Use the DescribeDBInstanceNetInfo API to query the real-time network connection information of the instance.>', 'type' => 'integer', 'format' => 'int64', 'example' => '6379', 'title' => ''], 'DestroyTime' => ['description' => 'The time when the instance was destroyed.', 'type' => 'string', 'example' => '2019-04-28T10:03:01Z', 'title' => ''], 'GlobalInstanceId' => ['description' => 'The ID of the distributed instance.'."\n" .'> This parameter is returned only when the instance is a child instance of a distributed instance.', 'type' => 'string', 'example' => 'gr-bp14rkqrhac****', 'title' => ''], 'HasRenewChangeOrder' => ['description' => 'Indicates whether the instance has an unexecuted order for renewal and configuration change. Valid values:'."\n" .'* **true**: yes.'."\n" .'* **false**: no.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ShardCount' => ['description' => 'The number of data shards in the cluster.'."\n" .'> This parameter is returned only for cloud-native cluster or read/write splitting instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'ConnectionDomain' => ['description' => 'The internal connection address of the instance.'."\n" .'>After the network connection address is changed or a new one is applied, this field cannot provide actual network status information of the instance. Use the DescribeDBInstanceNetInfo API to query the real-time network connection information of the instance.>', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', 'title' => ''], 'SlaveReplicaCount' => ['description' => 'The number of replica nodes in the secondary zone.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PrivateIp' => ['description' => 'The private IP address of the VPC.'."\n" .'> This parameter is not returned when the network type of the instance is classic network.', 'type' => 'string', 'example' => '172.16.49.***', 'title' => ''], 'Capacity' => ['description' => 'The storage capacity of the instance. Unit: MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'title' => ''], 'QPS' => ['description' => 'Queries per second (QPS).', 'type' => 'integer', 'format' => 'int64', 'example' => '100000', 'title' => ''], 'NetworkType' => ['description' => 'The network type of the instance. Valid values:'."\n" .'* **CLASSIC**: classic network.'."\n" .'* **VPC**: VPC.', 'type' => 'string', 'example' => 'CLASSIC', 'title' => ''], 'InstanceStatus' => ['description' => 'The status of the instance. Valid values:'."\n" .'* **Normal**: normal.'."\n" .'* **Creating**: being created.'."\n" .'* **Changing**: being changed.'."\n" .'* **Inactive**: disabled.'."\n" .'* **Flushing**: being flushed.'."\n" .'* **Released**: released.'."\n" .'* **Transforming**: being transformed.'."\n" .'* **Unavailable**: the service is suspended.'."\n" .'* **Error**: the instance failed to be created.'."\n" .'* **Migrating**: being migrated.'."\n" .'* **BackupRecovering**: being restored from a backup.'."\n" .'* **MinorVersionUpgrading**: minor version being upgraded.'."\n" .'* **NetworkModifying**: network type being changed.'."\n" .'* **SSLModifying**: SSL being changed.'."\n" .'* **MajorVersionUpgrading**: major version being upgraded. The instance can be accessed normally.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'PackageType' => ['description' => 'The plan type. Valid values:'."\n" .'* **standard**: standard plan.'."\n" .'* **customized**: custom plan.', 'type' => 'string', 'example' => 'standard', 'title' => ''], 'Bandwidth' => ['description' => 'The bandwidth of the instance. Unit: MB/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '96', 'title' => ''], 'InstanceType' => ['description' => 'The category of the instance. Valid values:'."\n" .'* **Tair**.'."\n" .'* **Redis**.'."\n" .'* **Memcache**.', 'type' => 'string', 'example' => 'Redis', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The tag information.', 'type' => 'array', 'items' => [ 'description' => 'Object.', 'type' => 'object', 'properties' => [ 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'value1', 'title' => ''], 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'key1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'ReplacateId' => ['description' => 'The logical ID of the active-active instance.', 'type' => 'string', 'example' => 'grr-bp11381ebc16****', 'title' => ''], 'ArchitectureType' => ['description' => 'The architecture type. Valid values:'."\n" .'* **cluster**: cluster.'."\n" .'* **standard**: standard.'."\n" .'* **rwsplit**: read/write splitting.'."\n" .'* **NULL**: all types. This is the default value.', 'type' => 'string', 'example' => 'cluster', 'title' => ''], 'EngineVersion' => ['description' => 'The Redis-compatible engine version of the instance.', 'type' => 'string', 'example' => '4.0', 'title' => ''], 'UserName' => ['description' => 'The username used for the connection. By default, a username named after the instance ID is included.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], 'CloudType' => ['description' => 'This parameter is displayed only for CloudBox instances.', 'type' => 'string', 'example' => 'cloudbox', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'ShardClass' => ['description' => 'The specification of data shard nodes. For more information, see [Specification lookup](~~26350~~).'."\n" .'> The overall performance of a cluster instance is: shard node specification (ShardClass) × number of shards (ShardCount).', 'type' => 'string', 'example' => 'redis.shard.small.ce', 'title' => ''], 'CreateTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2018-11-07T08:49:00Z', 'title' => ''], 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], 'ReplicaCount' => ['description' => 'The number of replica nodes in the primary zone.'."\n" .'> The **ReplicaCount** and **SlaveReplicaCount** parameters apply only to cloud-native instances. For cluster instances, these parameters indicate the number of replica nodes per shard in the primary and secondary zones, respectively.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ReadOnlyCount' => ['description' => 'The number of read-only nodes in the primary zone.'."\n" .'> The **ReadOnlyCount** and **SlaveReadOnlyCount** parameters apply only to cloud-native instances with read/write splitting enabled. For cluster instances, these parameters indicate the number of read-only nodes per shard in the primary and secondary zones, respectively.', 'type' => 'string', 'example' => '1', 'title' => ''], 'InstanceClass' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'redis.logic.sharding.2g.2db.0rodb.4proxy.default', 'title' => ''], 'IsRds' => ['description' => 'Indicates whether the instance is managed by ApsaraDB RDS. Valid values:'."\n" .'* **true**: yes.'."\n" .'* **false**: no.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'SecondaryZoneId' => ['description' => 'The ID of the secondary zone.'."\n" .'> If the **ZoneId** parameter already returns a multi-zone value, for example "cn-hangzhou-MAZ10(h,i)", this parameter does not return the secondary zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'apitest', 'title' => ''], 'SlaveReadOnlyCount' => ['description' => 'The number of read-only nodes in the secondary zone.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''], 'ChargeType' => ['description' => 'The billing method. Valid values:'."\n" .'* **PrePaid**: subscription.'."\n" .'* **PostPaid**: pay-as-you-go.', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''], 'ComputingType' => ['description' => 'The computing type of the instance. Valid values:'."\n" ."\n" .'- **Ecs**: cloud-native.'."\n" .'- **Machine**: physical machine.', 'type' => 'string', 'example' => 'Ecs', 'title' => ''], 'NodeType' => ['description' => 'The node type. Valid values:'."\n" .'* **double**: dual-replica.'."\n" .'* **single**: single replica (discontinued).'."\n" .'* **MASTER_SLAVE**: high availability (dual-replica).'."\n" .'* **STAND_ALONE**: single replica.', 'type' => 'string', 'example' => 'double', 'title' => ''], 'ConnectionMode' => ['description' => 'The access mode of the instance. Valid values:'."\n" .'* **Standard**: standard access mode.'."\n" .'* **Safe**: database proxy mode.'."\n" ."\n" .'Deprecated. Use DescribeDBInstanceNetInfo instead.', 'type' => 'string', 'example' => 'Standard', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'WorkspaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'UsedCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'QuotaCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidInstanceIds.Malformed', 'errorMessage' => 'The Specified parameter InstanceIds is not valid.', 'description' => ''], ], ], 'title' => 'Query instance list information', 'summary' => 'Queries information about one or more ApsaraDB for Redis (Tair-compatible) instances.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-08-12T12:34:05.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-02-27T08:28:54.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-10-09T05:56:54.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-06-19T12:38:55.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-04-13T07:08:51.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-03-07T08:03:28.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-03-07T08:03:28.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-03-07T08:03:28.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-03-07T08:03:28.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-03-07T08:03:28.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-10-25T13:32:25.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstances'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'kvstore:DescribeInstances', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'conditional', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/*'], ['validationType' => 'conditional', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E83311F-0EE4-4922-A3BF-730B312B****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 1,\\n \\"Instances\\": {\\n \\"KVStoreInstance\\": [\\n {\\n \\"Connections\\": 20000,\\n \\"EndTime\\": \\"2019-06-13T16:00:00Z\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"EditionType\\": \\"Enterprise\\",\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"maxmemory-policy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"volatile-lfu\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EvictionPolicy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"volatile-lru\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hash-max-ziplist-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"zset-max-ziplist-entries\\\\\\\\\\\\\\":128,\\\\\\\\\\\\\\"zset-max-ziplist-value\\\\\\\\\\\\\\":64,\\\\\\\\\\\\\\"set-max-intset-entries\\\\\\\\\\\\\\":512,\\\\\\\\\\\\\\"hash-max-ziplist-value\\\\\\\\\\\\\\":64,\\\\\\\\\\\\\\"#no_loose_disabled-commands\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"flushall,flushdb\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"lazyfree-lazy-eviction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"yes\\\\\\\\\\\\\\"}\\",\\n \\"Port\\": 6379,\\n \\"DestroyTime\\": \\"2019-04-28T10:03:01Z\\",\\n \\"GlobalInstanceId\\": \\"gr-bp14rkqrhac****\\",\\n \\"HasRenewChangeOrder\\": false,\\n \\"ShardCount\\": 3,\\n \\"ConnectionDomain\\": \\"r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com\\",\\n \\"SlaveReplicaCount\\": 1,\\n \\"PrivateIp\\": \\"172.16.49.***\\",\\n \\"Capacity\\": 4096,\\n \\"QPS\\": 100000,\\n \\"NetworkType\\": \\"CLASSIC\\",\\n \\"InstanceStatus\\": \\"Normal\\",\\n \\"PackageType\\": \\"standard\\",\\n \\"Bandwidth\\": 96,\\n \\"InstanceType\\": \\"Redis\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Value\\": \\"value1\\",\\n \\"Key\\": \\"key1\\"\\n }\\n ]\\n },\\n \\"ReplacateId\\": \\"grr-bp11381ebc16****\\",\\n \\"ArchitectureType\\": \\"cluster\\",\\n \\"EngineVersion\\": \\"4.0\\",\\n \\"UserName\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"CloudType\\": \\"cloudbox\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"ShardClass\\": \\"redis.shard.small.ce\\",\\n \\"CreateTime\\": \\"2018-11-07T08:49:00Z\\",\\n \\"VSwitchId\\": \\"vsw-bp1e7clcw529l773d****\\",\\n \\"ReplicaCount\\": 1,\\n \\"ReadOnlyCount\\": \\"1\\",\\n \\"InstanceClass\\": \\"redis.logic.sharding.2g.2db.0rodb.4proxy.default\\",\\n \\"IsRds\\": true,\\n \\"SecondaryZoneId\\": \\"cn-hangzhou-h\\",\\n \\"InstanceName\\": \\"apitest\\",\\n \\"SlaveReadOnlyCount\\": 1,\\n \\"VpcId\\": \\"vpc-bp1nme44gek34slfc****\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"ComputingType\\": \\"Ecs\\",\\n \\"NodeType\\": \\"double\\",\\n \\"ConnectionMode\\": \\"Standard\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"UsedCount\\": 0,\\n \\"QuotaCount\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeInstancesOverview' => [ 'summary' => 'Queries the overview information of one or more ApsaraDB for Tair (Redis® OSS-Compatible) database instances.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '103727', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeRegions](~~473763~~) operation to query the region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the instances that you want to query.'."\n" .'> By default, all instances under the current account are queried. To specify multiple instance IDs, separate them with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'InstanceStatus', 'in' => 'query', 'schema' => ['description' => 'The instance status. Valid values:'."\n" .'* **Normal**: The instance is running.'."\n" .'* **Creating**: The instance is being created.'."\n" .'* **Changing**: The instance is being modified.'."\n" .'* **Inactive**: The instance is disabled.'."\n" .'* **Flushing**: The instance is being purged.'."\n" .'* **Released**: The instance is released.'."\n" .'* **Transforming**: The instance is being transformed.'."\n" .'* **Migrating**: The instance is being migrated.'."\n" .'* **BackupRecovering**: The instance is being restored from a backup.'."\n" .'* **MinorVersionUpgrading**: A minor version upgrade is in progress.'."\n" .'* **NetworkModifying**: The network configuration is being modified.'."\n" .'* **SSLModifying**: The SSL configuration is being modified.'."\n" .'* **MajorVersionUpgrading**: A major engine version upgrade is in progress. The instance can be accessed normally.'."\n" ."\n" .'> For more information about instance statuses, see [Instance states and impacts](~~200740~~).', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method. Valid values:'."\n" .'* **PrePaid**: subscription.'."\n" .'* **PostPaid**: pay-as-you-go.', 'type' => 'string', 'required' => false, 'enum' => ['PrePaid', 'PostPaid', 'dhgpay'], 'example' => 'PostPaid', 'title' => '', ], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type. Valid values:'."\n" .'* **CLASSIC**: classic network.'."\n" .'* **VPC**: virtual private cloud (VPC).', 'type' => 'string', 'required' => false, 'enum' => ['CLASSIC', 'VPC'], 'example' => 'CLASSIC', 'title' => '', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The Redis-compatible engine version of the instance. Valid values: **2.8**, **4.0**, **5.0**, **6.0**, and **7.0**.', 'enumValueTitles' => ['4.0' => '4.0', '5.0' => '5.0', '6.0' => '6.0', '7.0' => '7.0', '2.8' => '2.8'], 'type' => 'string', 'required' => false, 'enum' => ['1.0', '2.8', '4.0', '5.0', '6.0', '7.0'], 'example' => '6.0', 'title' => '', ], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => ['description' => 'The instance type. For more information, see [Instance types](~~107984~~).', 'type' => 'string', 'required' => false, 'example' => 'redis.master.small.default', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The instance type. Valid values:'."\n" .'* **Tair**'."\n" .'* **Redis**'."\n" .'* **Memcache**', 'type' => 'string', 'required' => false, 'default' => 'Redis', 'enum' => ['Redis', 'Memcache', 'tair_essd', 'tair_scm', 'tair_rdb', 'Tair'], 'example' => 'Redis', 'title' => '', ], ], [ 'name' => 'SearchKey', 'in' => 'query', 'schema' => ['description' => 'The keyword used for fuzzy search by instance ID or instance description.', 'type' => 'string', 'required' => false, 'example' => 'apitest', 'title' => ''], ], [ 'name' => 'ArchitectureType', 'in' => 'query', 'schema' => ['description' => 'The architecture type. Valid values:'."\n" .'* **cluster**: Cluster Edition.'."\n" .'* **standard**: Standard Edition.'."\n" .'* **rwsplit**: read/write splitting edition.', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.'."\n" .'> You can invoke the [ListResourceGroups](~~158855~~) operation or use the console to obtain the resource group ID. Related operations, see [View basic information of a resource group](~~151181~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], [ 'name' => 'EditionType', 'in' => 'query', 'schema' => [ 'description' => 'The edition type. Valid values:'."\n" .'* **Community**: Community Edition.'."\n" .'* **Enterprise**: Enterprise Edition.', 'type' => 'string', 'required' => false, 'enum' => ['Enterprise', 'Community'], 'example' => 'Enterprise', 'title' => '', ], ], [ 'name' => 'PrivateIp', 'in' => 'query', 'schema' => ['description' => 'The private IP address.', 'type' => 'string', 'required' => false, 'example' => '172.16.49.***', 'title' => ''], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => ['STAND_ALONE', 'MASTER_SLAVE', 'double', 'single'], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1E83311F-0EE4-4922-A3BF-730B312B****', 'title' => ''], 'TotalCount' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Instances' => [ 'description' => 'The list of instances.', 'type' => 'array', 'items' => [ 'description' => 'The instance object.', 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''], 'PrivateIp' => ['description' => 'The private IP address of the instance in a VPC. The IP address may change. Use ConnectionDomain (internal endpoint) to connect to the instance.'."\n" .'> - This parameter is not returned if the network type of the instance is classic network.'."\n" .'> - This parameter is not returned for cloud-native instances.', 'type' => 'string', 'example' => '172.16.49.***', 'title' => ''], 'Capacity' => ['description' => 'The storage capacity of the instance. Unit: MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'title' => ''], 'CreateTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2018-11-07T08:49:00Z', 'title' => ''], 'ConnectionDomain' => ['description' => 'The internal endpoint of the instance.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', 'title' => ''], 'ChargeType' => ['description' => 'The billing method. Valid values:'."\n" .'* **PrePaid**: subscription.'."\n" .'* **PostPaid**: pay-as-you-go.', 'type' => 'string', 'example' => 'PrePaid', 'title' => ''], 'ArchitectureType' => ['description' => 'The architecture type. Valid values:'."\n" .'* **cluster**: Cluster Edition.'."\n" .'* **standard**: Standard Edition.'."\n" .'* **rwsplit**: read/write splitting edition.', 'type' => 'string', 'example' => 'cluster', 'title' => ''], 'NetworkType' => ['description' => 'The network type. Valid values:'."\n" .'* **CLASSIC**: classic network.'."\n" .'* **VPC**: virtual private cloud (VPC).', 'type' => 'string', 'example' => 'CLASSIC', 'title' => ''], 'EngineVersion' => ['description' => 'The Redis-compatible engine version of the instance. Valid values: **2.8**, **4.0**, **5.0**, **6.0**, and **7.0**.', 'type' => 'string', 'example' => '6.0', 'title' => ''], 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'apitest', 'title' => ''], 'GlobalInstanceId' => ['description' => 'The distributed instance ID.'."\n" .'> This parameter is returned only when the instance is a child instance of a distributed instance.', 'type' => 'string', 'example' => 'gr-bp14rkqrhac****', 'title' => ''], 'InstanceClass' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'redis.logic.sharding.2g.2db.0rodb.4proxy.default', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'InstanceType' => ['description' => 'The instance type. Valid values:'."\n" .'* **Tair**: Tair (Enterprise Edition).'."\n" .'* **Redis**: Redis Community Edition.'."\n" .'* **Memcache**', 'type' => 'string', 'example' => 'Redis', 'title' => ''], 'NodeType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'EndTime' => ['description' => 'The time when the subscription instance expires.', 'type' => 'string', 'example' => '2022-06-13T16:00:00Z', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], 'ResourceGroupId' => ['description' => 'The resource group ID to which the instance belongs.', 'type' => 'string', 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], 'InstanceStatus' => ['description' => 'The instance status. Valid values:'."\n" .'* **Normal**: The instance is running.'."\n" .'* **Creating**: The instance is being created.'."\n" .'* **Changing**: The instance is being modified.'."\n" .'* **Inactive**: The instance is disabled.'."\n" .'* **Flushing**: The instance is being purged.'."\n" .'* **Released**: The instance is released.'."\n" .'* **Transforming**: The instance is being transformed.'."\n" .'* **Unavailable**: The instance is unavailable.'."\n" .'* **Error**: The instance failed to be created.'."\n" .'* **Migrating**: The instance is being migrated.'."\n" .'* **BackupRecovering**: The instance is being restored from a backup.'."\n" .'* **MinorVersionUpgrading**: A minor version upgrade is in progress.'."\n" .'* **NetworkModifying**: The network configuration is being modified.'."\n" .'* **SSLModifying**: The SSL configuration is being modified.'."\n" .'* **MajorVersionUpgrading**: A major engine version upgrade is in progress. The instance can be accessed normally.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'SecondaryZoneId' => ['description' => 'The secondary zone ID.'."\n" .'> This parameter is returned only when the instance has a secondary zone.', 'type' => 'string', 'example' => 'cn-hangzhou-g', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidInstanceIds.Malformed', 'errorMessage' => 'The Specified parameter InstanceIds is not valid.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query instance overview', 'description' => 'If you do not specify any request parameters, the overview information of all instances is returned.'."\n" .'> This operation does not support pagination for the returned results.', 'changeSet' => [ ['createdAt' => '2023-06-12T09:03:22.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-03-06T12:59:26.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-11-26T14:44:59.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-11-23T14:22:35.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstancesOverview'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeInstancesOverview', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E83311F-0EE4-4922-A3BF-730B312B****\\",\\n \\"TotalCount\\": 1,\\n \\"Instances\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1nme44gek34slfc****\\",\\n \\"PrivateIp\\": \\"172.16.49.***\\",\\n \\"Capacity\\": 4096,\\n \\"CreateTime\\": \\"2018-11-07T08:49:00Z\\",\\n \\"ConnectionDomain\\": \\"r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"ArchitectureType\\": \\"cluster\\",\\n \\"NetworkType\\": \\"CLASSIC\\",\\n \\"EngineVersion\\": \\"6.0\\",\\n \\"InstanceName\\": \\"apitest\\",\\n \\"GlobalInstanceId\\": \\"gr-bp14rkqrhac****\\",\\n \\"InstanceClass\\": \\"redis.logic.sharding.2g.2db.0rodb.4proxy.default\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"InstanceType\\": \\"Redis\\",\\n \\"NodeType\\": \\"\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"EndTime\\": \\"2022-06-13T16:00:00Z\\",\\n \\"VSwitchId\\": \\"vsw-bp1e7clcw529l773d****\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyiu4ekp****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"InstanceStatus\\": \\"Normal\\",\\n \\"SecondaryZoneId\\": \\"cn-hangzhou-g\\"\\n }\\n ]\\n}","type":"json"}]', ], 'DescribeIntranetAttribute' => [ 'summary' => 'Describes the current bandwidth of a Tair (Redis-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56414', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AutoRenewal' => ['description' => 'Indicates whether auto-renewal is enabled for the bandwidth package. Valid values:'."\n" ."\n" .'- **true**: Auto-renewal is enabled.'."\n" ."\n" .'- **false**: Auto-renewal is disabled.'."\n" ."\n" .'> This parameter is not returned if no additional bandwidth is purchased.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25D42CC3-FBA1-4AEC-BCE2-B8DD3137****', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the temporary bandwidth. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format.'."\n" ."\n" .'> This parameter returns **0** if the instance has no temporary bandwidth or if the temporary bandwidth has expired.', 'type' => 'string', 'example' => '0', 'title' => ''], 'IntranetBandwidth' => ['description' => 'The total intranet bandwidth across all shards in the instance, in MB/s.', 'type' => 'integer', 'format' => 'int32', 'example' => '102', 'title' => ''], 'HasPrePaidBandWidthOrderRunning' => ['description' => 'Indicates whether the instance has an unexpired bandwidth package. Valid values:'."\n" ."\n" .'- **true**: An unexpired bandwidth package exists.'."\n" ."\n" .'- **false**: No unexpired bandwidth package exists.'."\n" ."\n" .'> This parameter is not returned if no additional bandwidth is purchased.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'BandwidthExpireTime' => ['description' => 'The expiration time of the bandwidth package. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format.'."\n" ."\n" .'> This parameter is not returned if no additional bandwidth is purchased.', 'type' => 'string', 'example' => '2021-03-06T16:00:00Z', 'title' => ''], 'BandwidthPrePaid' => ['description' => 'The billing method of the bandwidth package. Valid values:'."\n" ."\n" .'- **0**: pay-as-you-go.'."\n" ."\n" .'- **1**: subscription.', 'type' => 'string', 'example' => '0', 'title' => ''], 'IntranetBandWidthBurst' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AutoRenewal\\": true,\\n \\"RequestId\\": \\"25D42CC3-FBA1-4AEC-BCE2-B8DD3137****\\",\\n \\"ExpireTime\\": \\"0\\",\\n \\"IntranetBandwidth\\": 102,\\n \\"HasPrePaidBandWidthOrderRunning\\": true,\\n \\"BandwidthExpireTime\\": \\"2021-03-06T16:00:00Z\\",\\n \\"BandwidthPrePaid\\": \\"0\\",\\n \\"IntranetBandWidthBurst\\": 0\\n}","type":"json"}]', 'title' => 'DescribeIntranetAttribute', 'description' => 'You can call the [EnableAdditionalBandwidth](~~473771~~) operation to purchase additional bandwidth for an instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-12-22T07:19:29.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-06-06T08:07:31.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-15T12:48:14.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIntranetAttribute'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeIntranetAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeLogicInstanceTopology' => [ 'summary' => 'Queries the logical topology structure of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56415', 'abilityTreeNodes' => ['FEATUREkvstoreDER7E8', 'FEATUREkvstore4XSUU7'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '794120D1-E0CF-4713-BAE4-EBAEA04506AF', 'title' => ''], 'RedisProxyList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'NodeInfo' => [ 'description' => 'The proxy details, including proxy node information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Capacity' => ['description' => 'The capacity of the node. Unit: MB.', 'type' => 'string', 'example' => '5120', 'title' => ''], 'Connection' => ['description' => 'The maximum number of connections.', 'type' => 'string', 'example' => '320000', 'title' => ''], 'NodeType' => ['description' => 'The node type. Valid values:'."\n" .'* **db**: data node.'."\n" .'* **normal**: management node, which consists of a proxy node and a CS (configuration server) node. Some instances do not return normal but instead return proxy and cs separately.', 'type' => 'string', 'example' => 'proxy', 'title' => ''], 'Bandwidth' => ['description' => 'The bandwidth limit of the node. Unit: MB/s.', 'type' => 'string', 'example' => '96', 'title' => ''], 'NodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'r-bp10noxlhcoim2****-proxy-3#542****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RedisShardList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'NodeInfo' => [ 'description' => 'The shard details, including child node information such as NodeInfo.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Capacity' => ['description' => 'The capacity of the node. Unit: MB.', 'type' => 'string', 'example' => '2048', 'title' => ''], 'Connection' => ['description' => 'The maximum number of connections.', 'type' => 'string', 'example' => '10000', 'title' => ''], 'NodeType' => ['description' => 'The node type. Valid values:'."\n" .'* **proxy**: proxy node.'."\n" .'* **db**: data node.', 'type' => 'string', 'example' => 'db', 'title' => ''], 'Bandwidth' => ['description' => 'The bandwidth limit of the node. Unit: MB/s.', 'type' => 'string', 'example' => '96', 'title' => ''], 'NodeId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'r-bp10noxlhcoim2****-db-0#688****', 'title' => ''], 'SubInstanceType' => [ 'description' => 'The sub-instance type. Valid values:'."\n" .'* **master**: primary node.'."\n" .'* **readonly**: read-only instance.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'master', 'title' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Query the logical topology of an instance', 'description' => 'This operation is supported only for cluster and read/write splitting instances.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-08-21T06:42:09.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeLogicInstanceTopology'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeLogicInstanceTopology', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"RequestId\\": \\"794120D1-E0CF-4713-BAE4-EBAEA04506AF\\",\\n \\"RedisProxyList\\": {\\n \\"NodeInfo\\": [\\n {\\n \\"Capacity\\": \\"5120\\",\\n \\"Connection\\": \\"320000\\",\\n \\"NodeType\\": \\"proxy\\",\\n \\"Bandwidth\\": \\"96\\",\\n \\"NodeId\\": \\"r-bp10noxlhcoim2****-proxy-3#542****\\"\\n }\\n ]\\n },\\n \\"RedisShardList\\": {\\n \\"NodeInfo\\": [\\n {\\n \\"Capacity\\": \\"2048\\",\\n \\"Connection\\": \\"10000\\",\\n \\"NodeType\\": \\"db\\",\\n \\"Bandwidth\\": \\"96\\",\\n \\"NodeId\\": \\"r-bp10noxlhcoim2****-db-0#688****\\",\\n \\"SubInstanceType\\": \\"master\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeMonitorItems' => [ 'summary' => 'Queries the metrics of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56416', 'abilityTreeNodes' => ['FEATUREkvstoreW1V0SW'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8BEB2618-9517-43F3-A233-E0B34512****', 'title' => ''], 'MonitorItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'KVStoreMonitorItem' => [ 'description' => 'The returned metrics.'."\n" ."\n" .'> * **memoryUsage**, **GetQps**, and **PutQps** are supported only by Tair instances that use Redis 4.0 or later. **GetQps** and **PutQps** require the latest minor version. You can upgrade the major version or minor version of the instance as needed. For more information, see [Upgrade the major version](~~101764~~) and [Upgrade the minor version](~~56450~~).'."\n" .'> * When you use instances of Redis 2.8, if the **hit_rate** metric is not displayed, you must upgrade the minor version of the instance. For more information, see [Upgrade the minor version](~~56450~~).', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Unit' => ['description' => 'The unit of the metric.'."\n", 'type' => 'string', 'example' => 'Counts/s', 'title' => ''], 'MonitorKey' => ['description' => 'The metric.'."\n", 'type' => 'string', 'example' => 'select', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8BEB2618-9517-43F3-A233-E0B34512****\\",\\n \\"MonitorItems\\": {\\n \\"KVStoreMonitorItem\\": [\\n {\\n \\"Unit\\": \\"Counts/s\\",\\n \\"MonitorKey\\": \\"select\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\t8BEB2618-9517-43F3-A233-E0B34512****\\n\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\tdiscard\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\tzcount\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\tselect\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\tsunionstore\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\tzunionstore\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\tdel\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\tzinterstore\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\techo\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\thscan\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\tpsubscribe\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\ttype\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\tsinterstore\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\tmulti\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\trandomkey\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tCounts/s\\n\\t\\t\\tsetex\\n\\t\\t\\n\\t\\n","errorExample":"{\\n \\"MonitorItems\\" : {\\n \\"MonitorItem\\" : [{\\n \\"MonitorKey\\" : \\"GetQ\\",\\n \\"Unit\\" : \\"Counts/s\\"\\n }, {\\n \\"MonitorKey\\" : \\"Flush\\",\\n \\"Unit\\" : \\"Counts/s\\"\\n }, {\\n \\"MonitorKey\\" : \\"UsedMemCache\\",\\n \\"Unit\\" : \\"Bytes\\"\\n }, {\\n \\"MonitorKey\\" : \\"ReplaceQ\\",\\n \\"Unit\\" : \\"Counts/s\\"\\n }\\n ]\\n },\\n \\"RequestId\\" : \\"B906A893-58A3-4644-AC2D-A2C9B08706C1\\"\\n}"}]', 'title' => 'DescribeMonitorItems', 'description' => '> To improve user experience, Tair has upgraded the monitoring metrics. The DescribeMonitorItems operation is phased out. For more information, see [The DescribeMonitorItems operation of Tair (Redis OSS-compatible) is phased out](~~189893~~).'."\n" ."\n" .'After you call this operation to retrieve a list of metrics for a specified instance, you can call the [DescribeHistoryMonitorValues](~~473827~~) operation to query the monitoring history of the instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-04-24T08:37:02.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorItems'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeMonitorItems', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeParameterGroup' => [ 'summary' => 'Queries the basic information about a parameter template.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179009', 'abilityTreeNodes' => ['FEATUREkvstore9GDS4D'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the parameter template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rpg-sys-00*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****'], 'ParameterGroup' => [ 'description' => 'The information about the parameter template.'."\n", 'type' => 'object', 'properties' => [ 'EngineVersion' => ['description' => 'The compatible engine version.'."\n", 'type' => 'string', 'example' => '5.0', 'title' => ''], 'Modified' => ['description' => 'The time when the parameter template was last modified.'."\n", 'type' => 'string', 'example' => '2023-04-18 16:32:45', 'title' => ''], 'ParameterGroupName' => ['description' => 'The name of the parameter template.'."\n", 'type' => 'string', 'example' => 'testGroupName', 'title' => ''], 'ParameterGroupDesc' => ['description' => 'The description of the parameter template.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], 'Engine' => ['description' => 'The engine type. Valid values:'."\n" ."\n" .'* *redis*: Redis or Tair DRAM-based instance'."\n" .'* *tair_pena*: Tair persistent memory-optimized instance'."\n" .'* *tair_pdb*: Tair ESSD-based instance', 'type' => 'string', 'example' => 'redis', 'title' => ''], 'ParamGroupId' => ['description' => 'The parameter template ID, which is globally unique.'."\n", 'type' => 'string', 'example' => 'sys-001*****', 'title' => ''], 'Created' => ['description' => 'The time when the parameter template was created.'."\n", 'type' => 'string', 'example' => '2023-04-18 16:32:45', 'title' => ''], 'Category' => ['description' => 'The service category. Valid values:'."\n" ."\n" .'* **0**: Redis Open-Source Edition'."\n" .'* **1**: Tair (Enterprise Edition)'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'ParamGroupsDetails' => [ 'description' => 'The parameter details of the parameter template.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ParamName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'timeout', 'title' => ''], 'ParamValue' => ['description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => '1000', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A501A191-BD70-5E50-98A9-C2A486A82****\\",\\n \\"ParameterGroup\\": {\\n \\"EngineVersion\\": \\"5.0\\",\\n \\"Modified\\": \\"2023-04-18 16:32:45\\",\\n \\"ParameterGroupName\\": \\"testGroupName\\",\\n \\"ParameterGroupDesc\\": \\"test\\",\\n \\"Engine\\": \\"redis\\",\\n \\"ParamGroupId\\": \\"sys-001*****\\",\\n \\"Created\\": \\"2023-04-18 16:32:45\\",\\n \\"Category\\": 1,\\n \\"ParamGroupsDetails\\": [\\n {\\n \\"ParamName\\": \\"timeout\\",\\n \\"ParamValue\\": \\"1000\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeParameterGroup', 'changeSet' => [ ['createdAt' => '2024-06-17T11:39:39.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroup'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeParameterGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeParameterGroupSupportParam' => [ 'summary' => 'Queries the parameters that can be configured in parameter templates across different database versions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179022', 'abilityTreeNodes' => ['FEATUREkvstore9GDS4D'], ], 'parameters' => [ [ 'name' => 'Category', 'in' => 'query', 'schema' => ['description' => 'The service category. Valid values:'."\n" ."\n" .'* **standard**: ApsaraDB for Redis Community Edition'."\n" .'* **enterprise**: ApsaraDB for Redis Enhanced Edition (Tair)'."\n", 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => ['description' => 'The compatible engine version. Valid values:'."\n" ."\n" .'* For ApsaraDB for Redis Community Edition instances, set the parameter to **5.0**, **6.0**, or **7.0**.'."\n" .'* For Tair DRAM-based instances that are compatible with Redis 5.0 or Redis 6.0, set the parameter to **5.0** or **6.0**.'."\n" .'* For Tair persistent memory-optimized instances that are compatible with Redis 6.0, set the parameter to **1.0**.'."\n" .'* For Tair ESSD-based instances that are compatible with Redis 6.0, set the parameter to **1.0**. For Tair SSD-based instances that are compatible with Redis 6.0, set the parameter to **2.0**.'."\n", 'type' => 'string', 'required' => true, 'example' => '5.0', 'title' => ''], ], [ 'name' => 'EngineType', 'in' => 'query', 'schema' => ['description' => 'The engine type. Valid values:'."\n" ."\n" .'* **redis**: ApsaraDB for Redis Community Edition instance or Tair DRAM-based instance'."\n" .'* **tair_pena**: Tair persistent memory-optimized instance'."\n" .'* **tair_pdb**: Tair ESSD/SSD-based instance'."\n", 'type' => 'string', 'required' => false, 'example' => 'redis', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BB73740C-23E2-4392-9DA4-2660C74C****'], 'ResourceList' => [ 'description' => 'The parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The parameters.'."\n", 'type' => 'object', 'properties' => [ 'DbType' => ['description' => 'The engine type.'."\n", 'type' => 'string', 'example' => 'redis', 'title' => ''], 'DbVersion' => ['description' => 'The engine version.'."\n", 'type' => 'string', 'example' => '5.0', 'title' => ''], 'Category' => ['description' => 'The service category.'."\n", 'type' => 'string', 'example' => 'standard', 'title' => ''], 'ParamName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'rt_threshold_ms', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB73740C-23E2-4392-9DA4-2660C74C****\\",\\n \\"ResourceList\\": [\\n {\\n \\"DbType\\": \\"redis\\",\\n \\"DbVersion\\": \\"5.0\\",\\n \\"Category\\": \\"standard\\",\\n \\"ParamName\\": \\"rt_threshold_ms\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeParameterGroupSupportParam', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroupSupportParam'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeParameterGroupSupportParam', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeParameterGroupTemplateList' => [ 'summary' => 'Queries the information about the parameters that can be configured in a parameter template, such as the default values, value ranges, and descriptions.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '180928', 'abilityTreeNodes' => ['FEATUREkvstore9GDS4D'], ], 'parameters' => [ [ 'name' => 'Category', 'in' => 'query', 'schema' => ['description' => 'The service category. Valid values:'."\n" ."\n" .'* **standard**: Redis Open-Source Edition'."\n" .'* **enterprise**: Tair (Enterprise Edition)'."\n", 'type' => 'string', 'required' => true, 'example' => 'standard', 'title' => ''], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => ['description' => 'The compatible engine version. Valid values:'."\n" ."\n" .'* For Redis Open-Source Edition instances, set the parameter to **5.0**, **6.0**, or **7.0**.'."\n" .'* For Tair DRAM-based instances that are compatible with Redis 5.0, 6.0, or 7.0, set the parameter to **5.0**, **6.0**, or **7.0**.'."\n" .'* For Tair persistent memory-optimized instances that are compatible with Redis 6.0, set the parameter to **1.0**.'."\n" .'* For Tair ESSD-based instances that are compatible with Redis 6.0, set the parameter to **1.0**. For Tair SSD-based instances that are compatible with Redis 6.0, set the parameter to **2.0**.'."\n", 'type' => 'string', 'required' => true, 'example' => '5.0', 'title' => ''], ], [ 'name' => 'EngineType', 'in' => 'query', 'schema' => ['description' => 'The engine type. Valid values:'."\n" ."\n" .'* **redis**: Redis Open-Source Edition or Tair (In-Memory)'."\n" .'* **tair_pena**: Tair (On NVM)'."\n" .'* **tair_pdb**: Tair (On Disk)'."\n", 'type' => 'string', 'required' => true, 'example' => 'redis', 'title' => ''], ], [ 'name' => 'CharacterType', 'in' => 'query', 'schema' => ['description' => 'The role of the instance. Valid values: logic: logical instance. db: database instance. proxy: proxy node. cs: ConfigServer node. normal: master-replica database instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'db', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****'], 'EngineVersion' => ['description' => 'The compatible engine version. Valid values:'."\n" ."\n" .'Redis Open Source Edition: 5.0, 6.0, and 7.0. Tair DRAM-based instances: 5.0 and 6.0. Tair persistent memory-optimized instances: 6.0. Tair ESSD-based instances: 4.0.', 'type' => 'string', 'example' => '5', 'title' => ''], 'Parameters' => [ 'description' => 'The information about parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SupportModifyForMinorVersion' => ['description' => 'Indicates whether the minor version can be changed. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CheckingCode' => ['description' => 'The regular expression used to validate input.'."\n", 'type' => 'string', 'example' => '[0|1]', 'title' => ''], 'ParameterValue' => ['description' => 'The default value of the parameter.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'Revisable' => ['description' => 'Indicates whether the parameter can be modified. Valid values:'."\n" ."\n" .'* **0: The parameter cannot be modified.**'."\n" .'* **1**: The parameter can be modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'Factor' => ['description' => 'A divisor of the parameter. For a parameter of the integer or byte type, the valid values must be a multiple of Factor unless you set Factor to 0.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'ParameterName' => ['description' => 'The parameter name.'."\n", 'type' => 'string', 'example' => 'appendonly', 'title' => ''], 'Unit' => ['description' => 'The unit of the parameter value. Valid values: INT (ordinary integer), STRING (fixed string), and B (byte).'."\n", 'type' => 'string', 'example' => 'STRING', 'title' => ''], 'ParameterDescription' => ['description' => 'The description of the parameter.'."\n", 'type' => 'string', 'example' => '开启Aof持久化模式。', 'title' => ''], 'Effective' => ['description' => 'Indicates whether the modification takes effect. Valid values: 0 and 1. A value of 0 indicates that the modification does not take effect. A value of 1 indicates that the modification takes effect.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\",\\n \\"EngineVersion\\": \\"5\\",\\n \\"Parameters\\": [\\n {\\n \\"SupportModifyForMinorVersion\\": true,\\n \\"CheckingCode\\": \\"[0|1]\\",\\n \\"ParameterValue\\": \\"10\\",\\n \\"Revisable\\": 0,\\n \\"Factor\\": 1,\\n \\"ParameterName\\": \\"appendonly\\",\\n \\"Unit\\": \\"STRING\\",\\n \\"ParameterDescription\\": \\"开启Aof持久化模式。\\",\\n \\"Effective\\": 1\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeParameterGroupTemplateList', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroupTemplateList'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'kvstore:DescribeParameterGroupTemplateList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeParameterGroups' => [ 'summary' => 'Queries the list of available parameter templates.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179002', 'abilityTreeNodes' => ['FEATUREkvstore9GDS4D'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~473763~~) to query the region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DbType', 'in' => 'query', 'schema' => ['description' => 'The engine type. Valid values:'."\n" .'- **redis**: Redis Community Edition or Tair (Enhanced Edition) in-memory type.'."\n" .'- **tair_pena**: Tair (Enhanced Edition) persistent memory type.'."\n" .'- **tair_pdb**: Tair (Enhanced Edition) cloud disk type (ESSD/SSD).', 'type' => 'string', 'required' => false, 'example' => 'redis', 'title' => ''], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '686BB8A6-BBA5-47E5-8A75-D2ADE433****'], 'ParameterGroups' => [ 'description' => 'The list of parameter templates.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EngineVersion' => ['description' => 'The engine-compatible version.', 'type' => 'string', 'example' => '5', 'title' => ''], 'Modified' => ['description' => 'The most recent modification time of the parameter template.', 'type' => 'string', 'example' => '2023-04-18 16:32:45', 'title' => ''], 'ParameterGroupName' => ['description' => 'The name of the parameter template.', 'type' => 'string', 'example' => 'testGroupName', 'title' => ''], 'ParameterGroupDesc' => ['description' => 'The description of the parameter template.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Engine' => ['description' => 'The engine type. Valid values:'."\n" .'- **redis**: Redis Community Edition or Tair (Enhanced Edition) in-memory type.'."\n" .'- **tair_pena**: Tair (Enhanced Edition) persistent memory type.'."\n" .'- **tair_pdb**: Tair (Enhanced Edition) cloud disk type.', 'type' => 'string', 'example' => 'tair_pena', 'title' => ''], 'ParamGroupId' => ['description' => 'The parameter template ID.', 'type' => 'string', 'example' => 'test01', 'title' => ''], 'Created' => ['description' => 'The creation time of the parameter template.', 'type' => 'string', 'example' => '2023-04-18 16:32:45'."\n", 'title' => ''], 'Category' => ['description' => 'The product category. Valid values:'."\n" .'- **0**: Redis Community Edition'."\n" .'- **1**: Tair (Enhanced Edition)', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query parameter templates', 'changeSet' => [ ['createdAt' => '2024-06-17T11:39:39.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroups'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'kvstore:DescribeParameterGroups', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"686BB8A6-BBA5-47E5-8A75-D2ADE433****\\",\\n \\"ParameterGroups\\": [\\n {\\n \\"EngineVersion\\": \\"5\\",\\n \\"Modified\\": \\"2023-04-18 16:32:45\\",\\n \\"ParameterGroupName\\": \\"testGroupName\\",\\n \\"ParameterGroupDesc\\": \\"test\\",\\n \\"Engine\\": \\"tair_pena\\",\\n \\"ParamGroupId\\": \\"test01\\",\\n \\"Created\\": \\"2023-04-18 16:32:45\\\\n\\",\\n \\"Category\\": 0\\n }\\n ]\\n}","type":"json"}]', ], 'DescribeParameterModificationHistory' => [ 'summary' => 'Queries the parameter modification history of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56421', 'abilityTreeNodes' => ['FEATUREkvstore9GDS4D', 'FEATUREkvstoreDVVZYL'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the node.'."\n" ."\n" .'> You can set this parameter to query the parameter settings of the specified node in a cluster instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1xxxxxxxxxxxxx-db-0', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-09-05T08:49:27Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-09-05T09:49:27Z', 'title' => ''], ], [ 'name' => 'ParameterName', 'in' => 'query', 'schema' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'script_check_enable', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '963C20F0-7CE1-4591-AAF3-6F3CD1CE****', 'title' => ''], 'HistoricalParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'HistoricalParameter' => [ 'description' => 'The modification records of the parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The modification records of the parameter.'."\n", 'type' => 'object', 'properties' => [ 'OldParameterValue' => ['description' => 'The parameter value before modification.'."\n", 'type' => 'string', 'example' => '-2', 'title' => ''], 'ParameterName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'script_check_enable', 'title' => ''], 'NewParameterValue' => ['description' => 'The parameter value after modification.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'ModifyTime' => ['description' => 'The time when the parameter was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-09-05T09:56:10Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The Specified parameter StartTime is not valid.', 'description' => ''], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The Specified parameter EndTime is not valid.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"963C20F0-7CE1-4591-AAF3-6F3CD1CE****\\",\\n \\"HistoricalParameters\\": {\\n \\"HistoricalParameter\\": [\\n {\\n \\"OldParameterValue\\": \\"-2\\",\\n \\"ParameterName\\": \\"script_check_enable\\",\\n \\"NewParameterValue\\": \\"0\\",\\n \\"ModifyTime\\": \\"2022-09-05T09:56:10Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F8A9016D-51B4-56FF-AF08-2660FB8E92A8\\n \\n \\n -1\\n 2022-09-05T09:56:10Z\\n -2\\n list-max-ziplist-size\\n \\n \\n","errorExample":""}]', 'title' => 'DescribeParameterModificationHistory', 'changeSet' => [ ['createdAt' => '2022-09-16T08:10:04.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-09-16T08:10:04.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-23T12:02:00.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeParameterModificationHistory'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeParameterModificationHistory', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'], ], ], ], ], ], 'DescribeParameterTemplates' => [ 'summary' => 'Queries the parameters and their default values that are supported by Tair (Redis OSS-compatible) instances of different architectures and major versions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56423', 'abilityTreeNodes' => ['FEATUREkvstore9GDS4D'], ], 'parameters' => [ [ 'name' => 'CharacterType', 'in' => 'query', 'schema' => [ 'description' => 'The architecture of the instance. For more information, see [Overview](~~86132~~). Valid values:'."\n" ."\n" .'* **logic**: The instance is a cluster master-replica instance or a read/write splitting instance.'."\n" .'* **normal**: The instance is a standard master-replica instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'logic', 'enum' => ['logic', 'normal'], 'title' => '', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => ['description' => 'The database engine that is run on the instance. Set the value to **Redis**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Redis', 'title' => ''], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => ['description' => 'The major version of the instance. Valid values: **4.0**, **5.0**, **6.0**, and **7.0**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.0', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group to which the instance belongs. You can call the [ListResourceGroups](~~158855~~) operation to query the IDs of resource groups.'."\n" ."\n" .'> You can also query the ID of a resource group in the Resource Management console. For more information, see [View the basic information of a resource group](~~151181~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the IDs of instances.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9DA28D8E-514D-4F12-ADED-70A9C818****', 'title' => ''], 'Engine' => ['description' => 'The database engine that is run on the instance. The value **Redis** is returned for this parameter.'."\n", 'type' => 'string', 'example' => 'redis', 'title' => ''], 'EngineVersion' => ['description' => 'The major version of the instance.'."\n", 'type' => 'string', 'example' => '5.0', 'title' => ''], 'ParameterCount' => ['description' => 'The number of parameters that are supported by the instance.'."\n", 'type' => 'string', 'example' => '24', 'title' => ''], 'Parameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TemplateRecord' => [ 'description' => 'An array that consists of the details about the parameters returned.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CheckingCode' => ['description' => 'The valid values of the parameter.'."\n", 'type' => 'string', 'example' => '[yes|no]', 'title' => ''], 'ParameterName' => ['description' => 'The name of the parameter. For more information about the parameters and the parameter settings, see [Parameters](~~259681~~).'."\n", 'type' => 'string', 'example' => 'appendonly', 'title' => ''], 'ParameterValue' => ['description' => 'The default value of the parameter.'."\n", 'type' => 'string', 'example' => 'yes', 'title' => ''], 'ForceModify' => ['description' => 'Indicates whether the parameter can be reconfigured. Valid values:'."\n" ."\n" .'* **true**: The parameter can be reconfigured.'."\n" .'* **false**: The parameter cannot be reconfigured.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ForceRestart' => ['description' => 'Indicates whether a restart of the instance is required after the parameter is reconfigured. Valid values:'."\n" ."\n" .'* **true**: After the parameter is reconfigured, you must restart the instance to make the new value of the parameter take effect.'."\n" .'* **false**: After the parameter is reconfigured, the new value of the parameter immediately takes effect. You do not need to restart the instance.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ParameterDescription' => ['description' => 'The description of the parameter.'."\n", 'type' => 'string', 'example' => '开启aof持久化模式', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The parameter is invalid.'], ], 403 => [ ['errorCode' => 'ParamNotSupportedForCurrentVersion', 'errorMessage' => 'Parameter is not supported for current version.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9DA28D8E-514D-4F12-ADED-70A9C818****\\",\\n \\"Engine\\": \\"redis\\",\\n \\"EngineVersion\\": \\"5.0\\",\\n \\"ParameterCount\\": \\"24\\",\\n \\"Parameters\\": {\\n \\"TemplateRecord\\": [\\n {\\n \\"CheckingCode\\": \\"[yes|no]\\",\\n \\"ParameterName\\": \\"appendonly\\",\\n \\"ParameterValue\\": \\"yes\\",\\n \\"ForceModify\\": true,\\n \\"ForceRestart\\": true,\\n \\"ParameterDescription\\": \\"开启aof持久化模式\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => 'DescribeParameterTemplates', 'description' => 'After you call this operation to query the parameters and default values of an instance, you can call the [ModifyInstanceConfig](~~473844~~) operation to reconfigure the parameters of the instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterTemplates'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeParameterTemplates', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeParameters' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56422', 'abilityTreeNodes' => ['FEATUREkvstore9GDS4D'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~473763~~) to query available regions. Use this parameter to specify the region of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The node ID.'."\n" .'> Specify this parameter to query the parameter settings of a specific node in a cluster instance.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1xxxxxxxxxxxxx-db-0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9C1338BE-8DE8-4890-A900-E1BC06BF****', 'title' => ''], 'Engine' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'redis', 'title' => ''], 'EngineVersion' => ['description' => 'The database engine version.', 'type' => 'string', 'example' => '4.0', 'title' => ''], 'ConfigParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Parameter' => [ 'description' => 'The list of configuration parameters that have not taken effect.', 'type' => 'array', 'items' => [ 'description' => 'The object.', 'type' => 'object', 'properties' => [ 'CheckingCode' => ['description' => 'The check code that indicates the valid values of the parameter.', 'type' => 'string', 'example' => '[0|1]', 'title' => ''], 'ParameterName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'script_check_enable', 'title' => ''], 'ParameterValue' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ForceRestart' => ['description' => 'Indicates whether a restart is required for the parameter to take effect. Valid values:'."\n" .'* **True**: A restart is required.'."\n" .'* **False**: No restart is required. The parameter takes effect immediately after it is submitted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ParameterDescription' => ['description' => 'The description of the parameter.', 'type' => 'string', 'example' => 'Check all keys passed in the KEYS array map to the same slot.', 'title' => ''], 'ModifiableStatus' => ['description' => 'Indicates whether the parameter can be modified. Valid values:'."\n" .'* **False**: The parameter cannot be modified.'."\n" .'* **True**: The parameter can be modified.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RunningParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Parameter' => [ 'description' => 'The list of running parameters.', 'type' => 'array', 'items' => [ 'description' => 'The object.', 'type' => 'object', 'properties' => [ 'CheckingCode' => ['description' => 'The valid values of the parameter.', 'type' => 'string', 'example' => '[0|1]', 'title' => ''], 'ParameterName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => '#no_loose_disabled-commands', 'title' => ''], 'ParameterValue' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => 'keys,flushall,flushdb', 'title' => ''], 'ForceRestart' => ['description' => 'Indicates whether a restart is required for the parameter to take effect. Valid values:'."\n" .'* **True**: A restart is required.'."\n" .'* **False**: No restart is required. The parameter takes effect immediately after it is submitted.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'ParameterDescription' => ['description' => 'The description of the parameter.', 'type' => 'string', 'example' => 'You can disable some dangerous commands, for example \\"keys,flushdb,flushall\\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].', 'title' => ''], 'ModifiableStatus' => ['description' => 'Indicates whether the parameter can be modified. Valid values:'."\n" .'* **False**: The parameter cannot be modified.'."\n" .'* **True**: The parameter can be modified.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', 'description' => ''], ], [ ['errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', 'description' => ''], ], ], 'title' => 'Query configuration and running parameters of an instance', 'summary' => 'Queries the configuration parameters and running parameters of a Tair (Redis® OSS-Compatible) instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-12-08T07:53:00.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameters'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeParameters', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C1338BE-8DE8-4890-A900-E1BC06BF****\\",\\n \\"Engine\\": \\"redis\\",\\n \\"EngineVersion\\": \\"4.0\\",\\n \\"ConfigParameters\\": {\\n \\"Parameter\\": [\\n {\\n \\"CheckingCode\\": \\"[0|1]\\",\\n \\"ParameterName\\": \\"script_check_enable\\",\\n \\"ParameterValue\\": \\"1\\",\\n \\"ForceRestart\\": true,\\n \\"ParameterDescription\\": \\"Check all keys passed in the KEYS array map to the same slot.\\",\\n \\"ModifiableStatus\\": true\\n }\\n ]\\n },\\n \\"RunningParameters\\": {\\n \\"Parameter\\": [\\n {\\n \\"CheckingCode\\": \\"[0|1]\\",\\n \\"ParameterName\\": \\"#no_loose_disabled-commands\\",\\n \\"ParameterValue\\": \\"keys,flushall,flushdb\\",\\n \\"ForceRestart\\": \\"true\\",\\n \\"ParameterDescription\\": \\"You can disable some dangerous commands, for example \\\\\\\\\\\\\\"keys,flushdb,flushall\\\\\\\\\\\\\\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].\\",\\n \\"ModifiableStatus\\": \\"true\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribePrice' => [ 'summary' => 'Query the fees incurred by operations such as creation, configuration upgrade, or renewal of ApsaraDB for Tair (Redis OSS-compatible) instances.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56424', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW', 'FEATUREkvstore29KPQR', 'FEATUREkvstoreORY3QZ', 'FEATUREkvstoreMPSY6Q'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~473763~~) operation to query the region ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Capacity', 'in' => 'query', 'schema' => ['description' => 'The storage capacity of the instance. Unit: MB. This parameter is used only to query Redis Open-Source Edition instances that are deployed in classic mode. We recommend that you use the **InstanceClass** parameter to specify an exact instance type.'."\n" ."\n" .'> If you specify the **InstanceClass** parameter, you do not need to specify the Capacity parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1024', 'title' => ''], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => ['description' => 'The instance type.**** **To view the instance type, perform the following steps:**'."\n" ."\n" .'1. In the [Instance specifications](~~26350~~) topic, click the link in the **References for instance specifications** column corresponding to the instance type that you want to view.'."\n" .'2. In the instance type table of the specification documentation, find the instance type in the **InstanceClass** column.'."\n" ."\n" .'> If you want to query new instances, in addition to key parameters, you must also specify at least the following parameters:'."\n" ."\n" .'* To query a classic instance, specify this parameter.'."\n" ."\n" .'* To query a cloud-native standard instance, specify this parameter.'."\n" ."\n" .'* To query a cloud-native cluster instance, specify this parameter and the **ShardCount** parameter.'."\n" ."\n" .'* To query a cloud-native read/write splitting instance, specify this parameter and the **Instances** parameter.'."\n" ."\n" .'* To query multiple instances of different specifications or to query a Tair ESSD-based instance that has a custom storage type and storage capacity, specify the Instances parameter. In this case, you do not need to specify the InstanceClass parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'redis.master.small.default', 'title' => ''], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => [ 'description' => 'The order type. Valid values:'."\n" ."\n" .'* **BUY**: specifies the orders that are used to purchase instances.'."\n" .'* **UPGRADE**: specifies the orders that are used to change the configurations of instances.'."\n" .'* **RENEW**: specifies the orders that are used to renew instances.'."\n" .'* **CONVERT**: specifies the orders that are used to change the billing methods of instances.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'BUY', 'enum' => ['BUY', 'UPGRADE', 'DOWNGRADE', 'RENEW', 'CONVERT'], 'title' => '', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID. You can call the [DescribeZones](~~473764~~) operation to query the zone ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-e', 'title' => ''], ], [ 'name' => 'SecondaryZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the secondary zone. You can call the [DescribeZones](~~473764~~) API to query it.'."\n" .'> The values passed for this parameter and the ZoneId parameter must be different.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-g', 'title' => ''], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method. Valid values:'."\n" ."\n" .'* **PostPaid** (default): pay-as-you-go'."\n" .'* **PrePaid**: subscription'."\n", 'type' => 'string', 'required' => false, 'example' => 'PostPaid', 'default' => 'PostPaid', 'enum' => ['PrePaid', 'PostPaid'], 'title' => '', ], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => [ 'description' => 'The node type. Valid values:'."\n" ."\n" .'* **STAND_ALONE**: standalone'."\n" .'* **MASTER_SLAVE** (default): high availability (master-replica)'."\n", 'type' => 'string', 'required' => false, 'example' => 'MASTER_SLAVE', 'default' => 'MASTER_SLAVE', 'enum' => ['STAND_ALONE', 'MASTER_SLAVE'], 'title' => '', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The subscription duration. Unit: month. Valid values: **1**, 2, 3, 4, 5, 6, 7, 8, **9**, **12**, **24**, and **36**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'Quantity', 'in' => 'query', 'schema' => ['description' => 'The number of instances that you want to purchase. Valid values: **1** to **30**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n" ."\n" .'> This parameter is required when the **OrderType** parameter is set to **UPGRADE** or **RENEW**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Instances', 'in' => 'query', 'schema' => ['description' => 'If you want to query cloud-native read/write splitting instances, Tair ESSD-based instances, or instances of different specifications, you must specify this parameter as a JSON string. For more information, see the **Additional description of the Instances parameter** section.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","ShardClass": "tair.scm.with.proxy.standard.2m.8d","ShardCount": "3","Period": "1","Quantity": "1"}]', 'title' => ''], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => ['description' => 'The extended information such as the promotional event ID and business information.'."\n", 'type' => 'string', 'required' => false, 'example' => '000000000000', 'title' => ''], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => ['description' => 'The coupon code. Default value: youhuiquan_promotion_option_id_for_blank. This value indicates that no coupon code is available.'."\n", 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'default' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], ], [ 'name' => 'ForceUpgrade', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to forcefully change the configurations of the instance. Valid values:'."\n" ."\n" .'* **false**: forcefully changes the configurations.'."\n" .'* **true** (default): does not forcefully change the configurations.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', 'title' => ''], ], [ 'name' => 'OrderParamOut', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return parameters related to the order. Valid values:'."\n" ."\n" .'* **false** (default)'."\n" .'* **true**'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', 'default' => 'false', 'title' => ''], ], [ 'name' => 'ShardCount', 'in' => 'query', 'schema' => ['description' => 'The number of data shards in the cloud-native cluster instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => ['description' => 'The engine version of the instance. Valid values: **2.8**, **4.0**, and **5.0**.'."\n", 'type' => 'string', 'required' => false, 'example' => '5.0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderParams' => ['description' => 'The parameters of the order. When OrderParamOut is set to `true`, this parameter is returned.'."\n", 'type' => 'string', 'example' => 'String', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3A40BE4E-1890-4972-889C-FEFA37663635', 'title' => ''], 'Order' => [ 'description' => 'The information about the order.'."\n", 'type' => 'object', 'properties' => [ 'OriginalAmount' => ['description' => 'The original price of the order.'."\n", 'type' => 'string', 'example' => '0.21', 'title' => ''], 'HandlingFeeAmount' => ['description' => 'The service fees of the order.'."\n", 'type' => 'string', 'example' => '0.1', 'title' => ''], 'Currency' => ['description' => 'The currency used for payment. A value of CNY is used when the order was generated on the China site (aliyun.com), and a value of USD is used when the order was generated on the international site (alibabacloud.com).'."\n", 'type' => 'string', 'example' => 'CNY', 'title' => ''], 'DiscountAmount' => ['description' => 'The discount amount of the order.'."\n", 'type' => 'string', 'example' => '0.21', 'title' => ''], 'TradeAmount' => ['description' => 'The transaction price of the order.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'Coupons' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Coupon' => [ 'description' => 'Details about coupons.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Details about the coupon.'."\n", 'type' => 'object', 'properties' => [ 'IsSelected' => ['description' => 'Indicates whether the coupon is selected.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'CouponNo' => ['description' => 'The coupon ID.'."\n", 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], 'Name' => ['description' => 'The coupon name.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], 'Description' => ['description' => 'The coupon description.'."\n", 'type' => 'string', 'example' => 'coupondemo', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RuleIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RuleId' => [ 'description' => 'The rule IDs.'."\n", 'type' => 'array', 'items' => ['description' => 'The rule ID.'."\n", 'type' => 'string', 'example' => '[202]', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'ShowDiscountInfo' => ['description' => 'Indicates whether the discount information is displayed.'."\n", 'type' => 'boolean', 'title' => '', 'example' => ''], 'DepreciateInfo' => [ 'description' => 'The activity information.'."\n", 'type' => 'object', 'properties' => [ 'ListPrice' => ['description' => 'The list price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1*', 'title' => ''], 'OriginalStandAmount' => ['description' => 'The original total price displayed on the official website.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12*', 'title' => ''], 'CheapStandAmount' => ['description' => 'The new total price displayed on the official website.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9*', 'title' => ''], 'CheapRate' => ['description' => 'The price reduction rate.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30%', 'title' => ''], 'Differential' => ['description' => 'The promotional offer (displayed in the total order amount).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '**', 'title' => ''], 'DifferentialName' => ['description' => 'The name of the promotional offer.'."\n", 'type' => 'string', 'example' => 'XXXXX', 'title' => ''], 'MonthPrice' => ['description' => 'The monthly price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '**', 'title' => ''], 'IsContractActivity' => ['description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'IsShow' => ['description' => 'Indicates whether the price reduction rate is displayed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ContractActivity' => [ 'description' => 'The activity information.'."\n", 'type' => 'object', 'properties' => [ 'FinalPromFee' => ['description' => 'The total discount amount.'."\n", 'type' => 'number', 'format' => 'double', 'example' => "\n", 'title' => ''], 'FinalFee' => ['description' => 'The preferential price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => "\n", 'title' => ''], 'ProdFee' => ['description' => 'The original price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', 'title' => ''], 'ActivityId' => ['description' => 'The activity ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', 'title' => ''], 'OptionCode' => ['description' => 'The promotion code.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'ActivityName' => ['description' => 'The activity name.'."\n", 'type' => 'string', 'example' => '合同优惠_整单_xxx折', 'title' => ''], 'OptionIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'OptionId' => [ 'description' => 'The promotion IDs.'."\n", 'type' => 'array', 'items' => ['description' => 'The promotion ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '*****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'StandDiscountPrice' => ['description' => 'The discount.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', 'title' => ''], 'IsContractActivity' => ['description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => 'false'."\n", 'title' => ''], 'StandPrice' => ['description' => 'The discounted price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0'."\n", 'title' => ''], 'Code' => ['description' => 'The order code.'."\n", 'type' => 'string', 'example' => '""'."\n", 'title' => ''], 'Message' => ['description' => 'The information about the order.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Rules' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Rule' => [ 'description' => 'Details about promotion rules.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RuleDescId' => ['description' => 'The ID of the rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1111111111', 'title' => ''], 'Title' => ['description' => 'The title of the rule.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], 'Name' => ['description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'SubOrders' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SubOrder' => [ 'description' => 'The orders that match the coupons.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OriginalAmount' => ['description' => 'The original price of the order.'."\n", 'type' => 'string', 'example' => '0.21', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1xxxxxxxxxxxxx', 'title' => ''], 'DiscountAmount' => ['description' => 'The discount amount of the order.'."\n", 'type' => 'string', 'example' => '0.21', 'title' => ''], 'TradeAmount' => ['description' => 'The transaction price of the order.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], 'RuleIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RuleId' => [ 'description' => 'The hit rule IDs.'."\n", 'type' => 'array', 'items' => ['description' => 'The ID of the hit rule.'."\n", 'type' => 'string', 'example' => 'RuleId: 1111111111', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'OptionalPromotions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'OptionalPromotion' => [ 'description' => 'The optional promotions.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Selected' => ['description' => 'Indicates whether the promotion option is selected.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'CouponNo' => ['description' => 'Indicates whether coupons are used. Valid values:'."\n" ."\n" .'* default or null (default): Coupons are used.'."\n" .'* youhuiquan_promotion_option_id_for_blank: Coupons are not used.'."\n", 'type' => 'string', 'example' => 'default', 'title' => ''], 'Name' => ['description' => 'The coupon name.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'Description' => ['description' => 'The description of the coupon.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'Show' => ['description' => 'Indicates whether the discount is displayed.'."\n", 'type' => 'boolean', 'example' => 'False', 'title' => ''], 'ActivityExtInfo' => ['description' => 'The additional activity information.'."\n", 'type' => 'object', 'example' => '****', 'title' => ''], 'OptionCode' => ['description' => 'The promotion code.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'PromotionName' => ['description' => 'The promotion name.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'PromotionOptionNo' => ['description' => 'The promotion ID.'."\n", 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], 'CanPromFee' => ['description' => 'The amount that can be deducted by using the coupon.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'DepreciateInfo' => [ 'description' => 'The price reduction information.'."\n", 'type' => 'object', 'properties' => [ 'ListPrice' => ['description' => 'The list price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', 'title' => ''], 'OriginalStandAmount' => ['description' => 'The original total price displayed on the official website.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', 'title' => ''], 'CheapStandAmount' => ['description' => 'The new total price displayed on the official website.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', 'title' => ''], 'CheapRate' => ['description' => 'The price reduction rate.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', 'title' => ''], 'Differential' => ['description' => 'The promotional offer (displayed in the total order amount).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', 'title' => ''], 'DifferentialName' => ['description' => 'The name of the promotional offer.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'MonthPrice' => ['description' => 'The monthly price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', 'title' => ''], 'IsContractActivity' => ['description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ContractActivity' => [ 'description' => 'The contract promotion.'."\n", 'type' => 'object', 'properties' => [ 'FinalPromFee' => ['description' => 'The total discount amount.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', 'title' => ''], 'FinalFee' => ['description' => 'The preferential price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', 'title' => ''], 'ProdFee' => ['description' => 'The original price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', 'title' => ''], 'ActivityId' => ['description' => 'The activity ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1412025702634847', 'title' => ''], 'OptionCode' => ['description' => 'The promotion ID.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'ActivityName' => ['description' => 'The activity name.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'OptionIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'OptionId' => [ 'description' => 'The promotion IDs.'."\n", 'type' => 'array', 'items' => ['description' => 'The promotion ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => "\n", 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'StartTime' => ['description' => 'The start time of the activity.'."\n", 'type' => 'string', 'example' => '2024-11-18T00:00:00Z', 'title' => ''], ], 'title' => '', 'example' => '', ], 'StandDiscountPrice' => ['description' => 'The discounted price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', 'title' => ''], 'IsContractActivity' => ['description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => '****', 'title' => ''], 'StandPrice' => ['description' => 'The discounted price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', 'title' => ''], 'ModuleInstance' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ModuleInstance' => [ 'description' => 'The configuration details for each instance of an order line item.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The configuration sub-item of the instance in the order.'."\n", 'type' => 'object', 'properties' => [ 'ModuleCode' => ['description' => 'The module code.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'ModuleId' => ['description' => 'The module ID.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'StandPrice' => ['description' => 'The discounted price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', 'title' => ''], 'PricingModule' => ['description' => 'Indicates whether the item is billed.'."\n", 'type' => 'boolean', 'example' => '****', 'title' => ''], 'ModuleName' => ['description' => 'The module name.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'DiscountFee' => ['description' => 'The discount.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', 'title' => ''], 'TotalProductFee' => ['description' => 'The original price of the instance.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.0'."\n", 'title' => ''], 'NeedOrderPay' => ['description' => 'Indicates whether the order is paid.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'PayFee' => ['description' => 'The actual amount paid.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.0'."\n", 'title' => ''], 'ModuleAttrs' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'moduleAttr' => [ 'description' => 'The module attributes.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The module attribute.'."\n", 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The attribute type.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', 'title' => ''], 'Value' => ['description' => 'The attribute value.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'Code' => ['description' => 'The attribute code.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'Name' => ['description' => 'The attribute name.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'ContractActivity' => ['description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => '****', 'title' => ''], 'DepreciateInfo' => [ 'description' => 'The price reduction information.'."\n", 'type' => 'object', 'properties' => [ 'ListPrice' => ['description' => 'The list price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', 'title' => ''], 'OriginalStandAmount' => ['description' => 'The original total price displayed on the official website.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', 'title' => ''], 'CheapStandAmount' => ['description' => 'The new total price displayed on the official website.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', 'title' => ''], 'CheapRate' => ['description' => 'The price reduction rate.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '******', 'title' => ''], 'Differential' => ['description' => 'The promotional offer (displayed in the total order amount).'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', 'title' => ''], 'DifferentialName' => ['description' => 'The name of the promotional offer.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'MonthPrice' => ['description' => 'The monthly price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', 'title' => ''], 'IsContractActivity' => ['description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => '****', 'title' => ''], 'IsShow' => ['description' => 'Indicates whether the price reduction rate is displayed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'StartTime' => ['description' => 'The start time of the activity.'."\n", 'type' => 'string', 'example' => '2024-09-23T14:00:01Z', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'PromDetailList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'PromDetail' => [ 'description' => 'Details about promotions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Details about the promotion.'."\n", 'type' => 'object', 'properties' => [ 'PromotionName' => ['description' => 'The promotion name.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'PromotionId' => ['description' => 'The promotion ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', 'title' => ''], 'FinalPromFee' => ['description' => 'The discount amount.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', 'title' => ''], 'OptionCode' => ['description' => 'The coupon code.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'PromType' => ['description' => 'The promotion type.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'ActivityExtInfo' => ['description' => 'The additional activity information.'."\n", 'type' => 'object', 'example' => '****', 'title' => ''], 'DerivedPromType' => ['description' => 'The derived promotion type.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], 'PromotionCode' => ['description' => 'The promotion code.'."\n", 'type' => 'string', 'example' => '****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'ContractActivity' => ['description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => '****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', 'description' => ''], ['errorCode' => 'InvalidInstances.Format', 'errorMessage' => 'The Specified parameter Instances is not valid.', 'description' => 'The Instances parameter passed in is invalid'], ['errorCode' => 'AlreadyHadTemporaryBandwidth', 'errorMessage' => 'This instance have already had temporary bandwidth, please modify instance spec first.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderParams\\": \\"String\\",\\n \\"RequestId\\": \\"3A40BE4E-1890-4972-889C-FEFA37663635\\",\\n \\"Order\\": {\\n \\"OriginalAmount\\": \\"0.21\\",\\n \\"HandlingFeeAmount\\": \\"0.1\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"DiscountAmount\\": \\"0.21\\",\\n \\"TradeAmount\\": \\"10\\",\\n \\"Coupons\\": {\\n \\"Coupon\\": [\\n {\\n \\"IsSelected\\": \\"true\\",\\n \\"CouponNo\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"Name\\": \\"test\\",\\n \\"Description\\": \\"coupondemo\\"\\n }\\n ]\\n },\\n \\"RuleIds\\": {\\n \\"RuleId\\": [\\n \\"[202]\\"\\n ]\\n },\\n \\"ShowDiscountInfo\\": false,\\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\\": 0,\\n \\"FinalFee\\": 0,\\n \\"ProdFee\\": 0,\\n \\"ActivityId\\": 0,\\n \\"OptionCode\\": \\"****\\",\\n \\"ActivityName\\": \\"合同优惠_整单_xxx折\\",\\n \\"OptionIds\\": {\\n \\"OptionId\\": [\\n 0\\n ]\\n }\\n }\\n },\\n \\"StandDiscountPrice\\": 0,\\n \\"IsContractActivity\\": true,\\n \\"StandPrice\\": 0,\\n \\"Code\\": \\"\\\\\\"\\\\\\"\\\\n\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"Rules\\": {\\n \\"Rule\\": [\\n {\\n \\"RuleDescId\\": 1111111111,\\n \\"Title\\": \\"test\\",\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n },\\n \\"SubOrders\\": {\\n \\"SubOrder\\": [\\n {\\n \\"OriginalAmount\\": \\"0.21\\",\\n \\"InstanceId\\": \\"r-bp1xxxxxxxxxxxxx\\",\\n \\"DiscountAmount\\": \\"0.21\\",\\n \\"TradeAmount\\": \\"10\\",\\n \\"RuleIds\\": {\\n \\"RuleId\\": [\\n \\"RuleId: 1111111111\\"\\n ]\\n },\\n \\"OptionalPromotions\\": {\\n \\"OptionalPromotion\\": [\\n {\\n \\"Selected\\": false,\\n \\"CouponNo\\": \\"default\\",\\n \\"Name\\": \\"****\\",\\n \\"Description\\": \\"****\\",\\n \\"Show\\": true,\\n \\"ActivityExtInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"OptionCode\\": \\"****\\",\\n \\"PromotionName\\": \\"****\\",\\n \\"PromotionOptionNo\\": \\"youhuiquan_promotion_option_id_for_blank\\",\\n \\"CanPromFee\\": \\"****\\"\\n }\\n ]\\n },\\n \\"DepreciateInfo\\": {\\n \\"ListPrice\\": 0,\\n \\"OriginalStandAmount\\": 0,\\n \\"CheapStandAmount\\": 0,\\n \\"CheapRate\\": 0,\\n \\"Differential\\": 0,\\n \\"DifferentialName\\": \\"****\\",\\n \\"MonthPrice\\": 0,\\n \\"IsContractActivity\\": false,\\n \\"ContractActivity\\": {\\n \\"FinalPromFee\\": 0,\\n \\"FinalFee\\": 0,\\n \\"ProdFee\\": 0,\\n \\"ActivityId\\": 1412025702634847,\\n \\"OptionCode\\": \\"****\\",\\n \\"ActivityName\\": \\"****\\",\\n \\"OptionIds\\": {\\n \\"OptionId\\": [\\n 0\\n ]\\n }\\n },\\n \\"StartTime\\": \\"2024-11-18T00:00:00Z\\"\\n },\\n \\"StandDiscountPrice\\": 0,\\n \\"IsContractActivity\\": true,\\n \\"StandPrice\\": 0,\\n \\"ModuleInstance\\": {\\n \\"ModuleInstance\\": [\\n {\\n \\"ModuleCode\\": \\"****\\",\\n \\"ModuleId\\": \\"****\\",\\n \\"StandPrice\\": 0,\\n \\"PricingModule\\": true,\\n \\"ModuleName\\": \\"****\\",\\n \\"DiscountFee\\": 0,\\n \\"TotalProductFee\\": 0,\\n \\"NeedOrderPay\\": true,\\n \\"PayFee\\": 0,\\n \\"ModuleAttrs\\": {\\n \\"moduleAttr\\": [\\n {\\n \\"Type\\": 0,\\n \\"Value\\": \\"****\\",\\n \\"Code\\": \\"****\\",\\n \\"Name\\": \\"****\\"\\n }\\n ]\\n },\\n \\"ContractActivity\\": true,\\n \\"DepreciateInfo\\": {\\n \\"ListPrice\\": 0,\\n \\"OriginalStandAmount\\": 0,\\n \\"CheapStandAmount\\": 0,\\n \\"CheapRate\\": 0,\\n \\"Differential\\": 0,\\n \\"DifferentialName\\": \\"****\\",\\n \\"MonthPrice\\": 0,\\n \\"IsContractActivity\\": true,\\n \\"IsShow\\": true,\\n \\"StartTime\\": \\"2024-09-23T14:00:01Z\\"\\n }\\n }\\n ]\\n },\\n \\"PromDetailList\\": {\\n \\"PromDetail\\": [\\n {\\n \\"PromotionName\\": \\"****\\",\\n \\"PromotionId\\": 0,\\n \\"FinalPromFee\\": 0,\\n \\"OptionCode\\": \\"****\\",\\n \\"PromType\\": \\"****\\",\\n \\"ActivityExtInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DerivedPromType\\": \\"****\\",\\n \\"PromotionCode\\": \\"****\\"\\n }\\n ]\\n },\\n \\"ContractActivity\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Query price', 'requestParamsDescription' => '### Additional Notes on the Instances Parameter '."\n" .'The following notes apply only to the **Instances** parameter of the **DescribePrice** API and do not apply to other APIs. '."\n" ."\n" .''."\n" .''."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .''."\n" .''."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .''."\n" .'
NameTypeRequiredExample ValueDescription
RegionIdStringYescn-hangzhouThe region ID.
InstanceIdStringNor-7xv4s7q131smyx****The instance ID. This parameter is required when **OrderType** is **UPGRADE** or **RENEW**.
InstanceClassStringYesredis.master.small.defaultThe instance type for classic edition instances. For more information, see Instance Type Lookup Guide.
ShardClassStringYestair.rdb.2gThe instance type for cloud-native edition instances. For more information, see Instance Type Lookup Guide.
You must specify either this parameter or **InstanceClass**.
IzNoStringNocn-hangzhou-bThe zone ID.
NodeTypeStringNoMASTER_SLAVEThe node type. Valid values:
  • STAND_ALONE: single-replica edition.
  • MASTER_SLAVE (default): high availability (dual-replica).
PeriodLongNo1The subscription duration in months. Valid values: 1–9, 12, 24, and 36.
QuantityStringNo1The number of instances to purchase. Valid values: 1–30. Default value: 1.
VPCIdStringNovpc-bp1nme44gek34slfc****The VPC ID.
VSwitchIdStringNovsw-bp1e7clcw529l773d****The virtual switch ID.
AutoPayStringNotrueSpecifies whether to enable auto-payment. Valid values:
  • true (default): Yes
  • false: No
InstanceNameStringNotest_123The instance name.
ShardCountStringNo2The number of shard nodes. Default value: 1. You do not need to specify this parameter when querying standard architecture or read/write splitting architecture instances. This parameter applies only to cloud-native edition cluster architecture instances and allows you to customize the number of shards.
ReadOnlyCountIntegerNo2The total number of read-only nodes. This parameter applies only to creating cloud-native edition read/write splitting architecture instances.
StorageTypeStringNoessd_pl2The storage class for Tair ESSD disk-based instances. Valid values: essd_pl0, essd_pl1, essd_pl2, and essd_pl3. When you specify this parameter, you must also set Capacity to a custom disk capacity. For more information, see Disk-Based Instance Types.
CapacityLongNo512000The disk capacity for Tair ESSD disk-based instances. Unit: MB.
'."\n" ."\n" .'### Sample Requests '."\n" ."\n" .'Sample request to query the price for purchasing a new Tair cloud-native edition cluster architecture instance (in this scenario, the **Instances** parameter is not required): '."\n" .'
{'."\n"
                .'  "RegionId": "cn-hangzhou",'."\n"
                .'  "InstanceClass": "tair.rdb.with.proxy.2g",'."\n"
                .'  "OrderType": "BUY",'."\n"
                .'  "ChargeType": "PrePaid",'."\n"
                .'  "Period": 1,'."\n"
                .'  "ShardCount": 3'."\n"
                .'}
'."\n" ."\n" .'Sample request to query the price for purchasing a new Tair ESSD disk-based instance with a custom storage class: '."\n" .'
{'."\n"
                .'  "RegionId": "cn-hangzhou",'."\n"
                .'  "OrderType": "BUY",'."\n"
                .'  "ChargeType": "PostPaid",'."\n"
                .'  "Instances": "[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-h", "ShardClass": "tair.essd.standard.2xlarge", "ShardCount": "1","Capacity": "512000","StorageType": "essd_pl2"}]"'."\n"
                .'}
'."\n" ."\n" .'Sample request to query the price for purchasing a new Tair cloud-native edition read/write splitting architecture instance: '."\n" .'
{'."\n"
                .'  "RegionId": "cn-hangzhou",'."\n"
                .'  "InstanceClass": "tair.rdb.with.proxy.2g",'."\n"
                .'  "OrderType": "BUY",'."\n"
                .'  "ChargeType": "PrePaid",'."\n"
                .'  "Period": 1,'."\n"
                .'  "Instances": "[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","ShardClass":"tair.rdb.with.proxy.2g","ReadOnlyCount":"2"}]"'."\n"
                .'}'."\n"
                .'
'."\n" ."\n" .'Sample request to query the price for purchasing multiple instances: '."\n" .'
{'."\n"
                .'  "RegionId": "cn-hangzhou",'."\n"
                .'  "OrderType": "BUY",'."\n"
                .'  "ChargeType": "PrePaid",'."\n"
                .'  "Period": 1,'."\n"
                .'  "Instances": "[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","InstanceClass": "redis.master.small.default"}{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","InstanceClass": "redis.amber.logic.sharding.1g.2db.0rodb.6proxy.multithread"}{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","ShardClass":"tair.rdb.with.proxy.2g","ShardCount":"3"}]"'."\n"
                .'}'."\n"
                .'
'."\n" ."\n" .'Sample request to query the renewal price for a Tair cloud-native edition cluster architecture instance (in this scenario, the **Instances** parameter is not required): '."\n" .'
{'."\n"
                .'  "RegionId": "cn-hangzhou",'."\n"
                .'  "InstanceClass": "tair.rdb.with.proxy.1g",'."\n"
                .'  "OrderType": "RENEW",'."\n"
                .'  "ChargeType": "PrePaid",'."\n"
                .'  "Period": 12,'."\n"
                .'  "InstanceId": "r-d7****l3v0xmorw1xp",'."\n"
                .'  "ShardCount": 3'."\n"
                .'}'."\n"
                .'
', 'changeSet' => [ ['createdAt' => '2025-08-11T02:05:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-02-10T11:34:24.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-07-31T03:05:59.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-04-10T07:56:28.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-04-07T05:47:29.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-03-26T02:04:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-02-28T03:07:15.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-18T06:07:02.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePrice'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribePrice', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeRegions' => [ 'summary' => 'Queries all regions and zones supported for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56428', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'AcceptLanguage', 'in' => 'query', 'schema' => ['description' => 'The display language of the **LocalName** parameter value. Valid values:'."\n" ."\n" .'* **zh-CN**: Chinese'."\n" .'* **en-US**: English'."\n" ."\n" .'> The default value is **zh-CN**.', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AD425AD3-CC7B-4EE2-A5CB-2F61BA73****', 'title' => ''], 'RegionIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'KVStoreRegion' => [ 'description' => 'The **region IDs**.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RegionEndpoint' => ['description' => 'The endpoint of the region.'."\n", 'type' => 'string', 'example' => 'r-kvstore.aliyuncs.com', 'title' => ''], 'LocalName' => ['description' => 'The name of the region.'."\n", 'type' => 'string', 'example' => '华东1（杭州）', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'ZoneIds' => ['description' => 'The IDs of the zones in the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], 'ZoneIdList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ZoneId' => [ 'description' => 'The zone IDs.'."\n", 'type' => 'array', 'items' => ['description' => 'The ID of the zone.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AD425AD3-CC7B-4EE2-A5CB-2F61BA73****\\",\\n \\"RegionIds\\": {\\n \\"KVStoreRegion\\": [\\n {\\n \\"RegionEndpoint\\": \\"r-kvstore.aliyuncs.com\\",\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneIds\\": \\"cn-hangzhou-h\\",\\n \\"ZoneIdList\\": {\\n \\"ZoneId\\": [\\n \\"cn-hangzhou-h\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":"{\\n \\"RequestId\\":\\"535A88D3-5408-4B29-AFD4-07319D97EBC4\\",\\n \\"RegionIds\\":\\n {\\n {\\n \\"ZoneIds\\":\\"cn-qingdao-b\\",\\n \\"RegionId\\":\\"cn-qingdao\\",\\n },\\n {\\n \\"ZoneIds\\":\\"cn-shenzhen-a\\",\\n \\"RegionId\\":\\"cn-shenzhen\\",\\n },\\n {\\n \\"ZoneIds\\":\\"cn-hangzhou-d,cn-hangzhou-b\\",\\n \\"RegionId\\":\\"cn-hangzhou\\"\\n },\\n {\\n \\"ZoneIds\\":\\"cn-beijing-a\\",\\n \\"RegionId\\":\\"cn-beijing\\"\\n }\\n }\\n}"}]', 'title' => 'DescribeRegions', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-10-25T13:32:25.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [], ], 'DescribeRoleZoneInfo' => [ 'summary' => 'Queries the role, type, minor version, and zone of each node in a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56434', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-t4nlenc2p04uvb****', 'title' => ''], ], [ 'name' => 'QueryType', 'in' => 'query', 'schema' => ['description' => 'The type of the node to query. Default value: 1. Valid values:'."\n" ."\n" .'* **0**: proxy node'."\n" ."\n" .' **'."\n" ."\n" .' **Note** This parameter is supported only for cluster instances and read/write splitting instances.'."\n" ."\n" .'* **1**: data node'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than **0** and less than or equal to the maximum value supported by the integer data type. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: **10**, **20**, and **50**. Default value: **10**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10', 'enum' => ['5', '10', '20', '50', '100', '200', '1'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '224B97FB-A275-4EAC-86E9-8922FEA2****', 'title' => ''], 'PageNumber' => ['description' => 'The number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'Node' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'NodeInfo' => [ 'description' => 'Details about each node in the instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DefaultBandWidth' => ['description' => 'The default bandwidth of the node. Unit: MB/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '96', 'title' => ''], 'CurrentMinorVersion' => ['description' => 'The minor version of the node.'."\n", 'type' => 'string', 'example' => 'redis-5.0_0.3.10', 'title' => ''], 'CurrentBandWidth' => ['description' => 'The current bandwidth of the node, which consists of the default bandwidth and the increased bandwidth. Unit: MB/s.'."\n" ."\n" .'> * You can call the [EnableAdditionalBandwidth](~~473771~~) operation to specify the increased bandwidth.'."\n" .'> * You can also use this parameter to calculate the increased bandwidth. For example, if the default bandwidth of the node is 96 MB/s and the returned value of this parameter is 100, the increased bandwidth is 4 MB/s.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'InsType' => ['description' => 'Indicates whether the node is a read replica. If the node is a read replica, **3** is returned.'."\n" ."\n" .'> If the node is not a read replica, no value is returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'IsLatestVersion' => ['description' => 'Indicates whether the minor version is the latest version. Valid values:'."\n" ."\n" .'* **0**: The minor version is not the latest version.'."\n" .'* **1**: The minor version is the latest version.'."\n" ."\n" .'> To update the minor version, call the [ModifyInstanceMinorVersion](~~473777~~) operation.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'InsName' => ['description' => 'The ID of the node.'."\n", 'type' => 'string', 'example' => 'r-t4nlenc2p04uvb****', 'title' => ''], 'NodeType' => ['description' => 'The node type. Valid values:'."\n" ."\n" .'* **db**: data node.'."\n" .'* **proxy**: proxy node.'."\n" .'* **normal**: regular node. This value is returned when the instance runs in the standard architecture.'."\n", 'type' => 'string', 'example' => 'normal', 'title' => ''], 'ZoneId' => ['description' => 'The ID of the zone.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], 'IsOpenBandWidthService' => ['description' => 'Indicates whether the bandwidth of the node is increased. Valid values:'."\n" ."\n" .'* **true**: The bandwidth of the node is not increased.'."\n" .'* **false**: The bandwidth of the node is increased.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CustinsId' => ['description' => 'The ID of the data shard.'."\n", 'type' => 'string', 'example' => '30381****', 'title' => ''], 'Role' => ['description' => 'The role of the node. Valid values:'."\n" ."\n" .'* **master**: master node'."\n" .'* **slave**: replica node'."\n", 'type' => 'string', 'example' => 'master', 'title' => ''], 'NodeId' => ['description' => 'This parameter is used only for internal maintenance of instances.'."\n", 'type' => 'string', 'example' => '10065****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"224B97FB-A275-4EAC-86E9-8922FEA2****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"Node\\": {\\n \\"NodeInfo\\": [\\n {\\n \\"DefaultBandWidth\\": 96,\\n \\"CurrentMinorVersion\\": \\"redis-5.0_0.3.10\\",\\n \\"CurrentBandWidth\\": 100,\\n \\"InsType\\": 3,\\n \\"IsLatestVersion\\": 1,\\n \\"InsName\\": \\"r-t4nlenc2p04uvb****\\",\\n \\"NodeType\\": \\"normal\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"IsOpenBandWidthService\\": true,\\n \\"CustinsId\\": \\"30381****\\",\\n \\"Role\\": \\"master\\",\\n \\"NodeId\\": \\"10065****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 2\\n 224B97FB-A275-4EAC-86E9-8922FEA2****\\n 10\\n 1\\n \\n \\n slave\\n 1\\n cn-hangzhou-b\\n normal\\n true\\n 10065****\\n redis-5.0_0.3.10\\n 30381****\\n 96\\n r-t4nlenc2p04uvb****\\n 100\\n \\n \\n master\\n 1\\n cn-hangzhou-b\\n normal\\n true\\n 10065****\\n redis-5.0_0.3.10\\n 30381****\\n 96\\n r-t4nlenc2p04uvb****\\n 100\\n \\n \\n\\n","errorExample":""}]', 'title' => 'DescribeRoleZoneInfo', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-09-26T13:08:34.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRoleZoneInfo'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeRoleZoneInfo', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeRunningLogRecords' => [ 'summary' => 'Queries the operational logs of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56435', 'abilityTreeNodes' => ['FEATUREkvstoreGDG2ED'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the node in the instance. You can set this parameter to query the operational logs of a specified node.'."\n" ."\n" .'> '."\n" ."\n" .'* This parameter is available only for read/write splitting and cluster instances.'."\n" ."\n" .'* If you set this parameter, you must also set the **CharacterType** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-12-03T07:01Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. The time range cannot exceed one day. We recommend that you specify 1 hour. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-12-03T08:01Z', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RoleType', 'in' => 'query', 'schema' => [ 'description' => 'The role of the data shard. Default value: master. Valid values:'."\n" ."\n" .'* **master**: master node'."\n" .'* **slave**: replica node'."\n", 'type' => 'string', 'required' => false, 'example' => 'master', 'default' => 'master', 'enum' => ['master', 'primary', 'secondary'], 'title' => '', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **30**, **50**, and **100**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', 'enum' => ['30', '50', '100'], 'title' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. The value must be an integer that is greater than **0** and less than or equal to the maximum value supported by the integer data type. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], [ 'name' => 'CharacterType', 'in' => 'query', 'schema' => [ 'description' => 'The shard type of the cluster instance. Valid values:'."\n" ."\n" .'* **proxy**: proxy node'."\n" .'* **db**: data node'."\n" .'* **cs**: config server node'."\n" ."\n" .'> If you set this parameter, you must also set the **NodeId** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'proxy', 'enum' => ['proxy', 'db', 'cs'], 'title' => '', ], ], [ 'name' => 'QueryKeyword', 'in' => 'query', 'schema' => ['description' => 'The keyword that is used to query operational logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aof', 'title' => ''], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => ['description' => 'The method that is used to sort the returned log entries. Valid values:'."\n" ."\n" .'* **asc**: ascending order'."\n" .'* **desc**: descending order'."\n", 'type' => 'string', 'required' => false, 'example' => 'asc', 'default' => 'desc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'The beginning of the time range to query.'."\n", 'type' => 'string', 'example' => '2018-12-03T07:01Z', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '093B8579-9264-43A0-ABA9-AA86****', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of log entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'PageSize' => ['description' => 'The maximum number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'Engine' => ['description' => 'The type of the database engine.'."\n", 'type' => 'string', 'example' => 'Redis', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'LogRecords' => [ 'description' => 'Details about the log entries.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The time when the log was generated. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2018-12-03T07:07:30Z', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'Content' => ['description' => 'The content of the log.'."\n", 'type' => 'string', 'example' => 'CONFIG REWRITE executed with success.', 'title' => ''], 'NodeId' => ['description' => 'The ID of the node.'."\n" ."\n" .'> If a standard instance is queried, `(null)` is returned.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The Specified parameter StartTime is not valid.', 'description' => ''], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The Specified parameter EndTime is not valid.', 'description' => ''], ['errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', 'description' => ''], ], 404 => [ ['errorCode' => 'InvalidDbInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"StartTime\\": \\"2018-12-03T07:01Z\\",\\n \\"RequestId\\": \\"093B8579-9264-43A0-ABA9-AA86****\\",\\n \\"PageRecordCount\\": 5,\\n \\"TotalRecordCount\\": 5,\\n \\"PageSize\\": 30,\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"Engine\\": \\"Redis\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"LogRecords\\": [\\n {\\n \\"CreateTime\\": \\"2018-12-03T07:07:30Z\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"Content\\": \\"CONFIG REWRITE executed with success.\\",\\n \\"NodeId\\": \\"r-bp1zxszhcgatnx****-db-0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n D73451AC-B9BA-46AA-8972-C17B967E****\\n 30\\n r-bp10noxlhcoim2****\\n 1\\n 2020-11-08T02:00Z\\n \\n \\n r-bp10noxlhcoim2****\\n 126732:M 08 Nov 2020 10:02:03.955 # CONFIG REWRITE executed with success.\\n 2020-11-08T02:02:06Z\\n \\n \\n","errorExample":""}]', 'title' => 'DescribeRunningLogRecords', 'description' => 'For more information about how to view the operational logs of an instance in the Tair (Redis OSS-compatible) console, see [View active logs](~~101713~~).'."\n" ."\n" .'This operation can be called up to 100 times per minute.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRunningLogRecords'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeRunningLogRecords', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeSecurityGroupConfiguration' => [ 'summary' => 'Queries the security groups that are added to the whitelists of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56436', 'abilityTreeNodes' => ['FEATUREkvstoreW1V0SW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '981C0D6A-D9DD-466C-92DA-F29DF755****', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'EcsSecurityGroupRelation' => [ 'description' => 'The list of security groups.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SecurityGroupId' => ['description' => 'The ID of the security group.'."\n", 'type' => 'string', 'example' => 'sg-bp14p9y07ns3gwq****', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region where the instance is deployed.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'NetType' => ['description' => 'The network type of the security group. Valid values:'."\n" ."\n" .'* **classic**: the classic network.'."\n" .'* **vpc**: the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => 'vpc', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The InstanceId provided does not exist in our records.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"981C0D6A-D9DD-466C-92DA-F29DF755****\\",\\n \\"Items\\": {\\n \\"EcsSecurityGroupRelation\\": [\\n {\\n \\"SecurityGroupId\\": \\"sg-bp14p9y07ns3gwq****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"NetType\\": \\"vpc\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 981C0D6A-D9DD-466C-92DA-F29DF755****\\n \\n \\n sg-bp14p9y07ns3gwq****\\n cn-hangzhou\\n vpc\\n \\n \\n","errorExample":""}]', 'title' => 'DescribeSecurityGroupConfiguration', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-08-16T03:15:21.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSecurityGroupConfiguration'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeSecurityGroupConfiguration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'dbinstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ], ], ], 'DescribeSecurityIps' => [ 'summary' => 'Queries the IP address whitelists of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56437', 'abilityTreeNodes' => ['FEATUREkvstoreFPM1AL'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EFC9161F-15E3-4A6E-8A99-C09916D1****', 'title' => ''], 'SecurityIpGroups' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'SecurityIpGroup' => [ 'description' => 'The whitelists of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SecurityIpGroupAttribute' => ['description' => 'The attribute of the whitelist. This parameter is empty by default.'."\n" ."\n" .'> If the instance is authorized to use a service such as Database Autonomy Service (DAS), Data Management (DMS), or Data Transmission Service (DTS), this service automatically generates a **hidden** whitelist for the instance. This type of whitelists cannot be modified or deleted.'."\n", 'type' => 'string', 'example' => 'hidden', 'title' => ''], 'SecurityIpList' => ['description' => 'The IP addresses in the whitelist. A maximum of 1,000 IP addresses can be specified in a whitelist.'."\n", 'type' => 'string', 'example' => '100.100.202.***/24,10.10.10.***', 'title' => ''], 'SecurityIpGroupName' => ['description' => 'The name of the whitelist.'."\n", 'type' => 'string', 'example' => 'default', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The InstanceId provided does not exist in our records.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EFC9161F-15E3-4A6E-8A99-C09916D1****\\",\\n \\"SecurityIpGroups\\": {\\n \\"SecurityIpGroup\\": [\\n {\\n \\"SecurityIpGroupAttribute\\": \\"hidden\\",\\n \\"SecurityIpList\\": \\"100.100.202.***/24,10.10.10.***\\",\\n \\"SecurityIpGroupName\\": \\"default\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"SecurityIpGroups\\":{\\n \\"SecurityIpGroup\\":[{\\n \\"SecurityIpList\\":\\"127.0.0.1\\",\\n\\t\\t\\"SecurityIpGroupAttribute\\":\\"\\",\\n\\t\\t\\"SecurityIpGroupName\\":\\"default\\"\\n\\t\\t\\t\\t\\t },{\\n \\"SecurityIpList\\":\\"11.xxx.xxx.xxx,10.xxx.xxx.xxx\\",\\n\\t\\t\\"SecurityIpGroupAttribute\\":\\"hidden\\",\\n\\t \\"SecurityIpGroupName\\":\\"rds_replica_group\\"\\n\\t\\t\\t\\t\\t\\t}]\\n\\t\\t\\t\\t\\t },\\n \\"RequestId\\":\\"EFC9161F-15E3-4A6E-8A99-C09916D1F464\\"\\n}"},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n 127.0.0.1\\r\\n \\r\\n default\\r\\n \\r\\n \\r\\n 100.100.202.***/24,10.10.10.***\\r\\n hidden\\r\\n rds_replica_group\\r\\n \\r\\n \\r\\n EFC9161F-15E3-4A6E-8A99-C09916D1****\\r\\n","errorExample":"\\n \\n \\n 127.0.0.1\\n \\n default\\n \\n \\n 11.111.111.111,10.200.200.200\\n hidden\\n rds_replica_group\\n \\n \\n EFC9161F-15E3-4A6E-8A99-C09916D1F464\\n"}]', 'title' => 'DescribeSecurityIps', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-08-16T03:19:50.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSecurityIps'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeSecurityIps', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'DescribeServiceLinkedRoleExists' => [ 'summary' => 'Queries whether the related service-linked role is created for Tair (Redis OSS-compatible) in the current account.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56438', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance resides.'."\n" ."\n" .'> This parameter does not affect the query results. You can specify any region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => ['description' => 'The database engine of the instance. Only Redis is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Redis', 'default' => 'Redis', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ExistsServiceLinkedRole' => ['description' => 'Indicates whether the service-linked role is created for Tair (Redis OSS-compatible) in the current account. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => '90B82DB7-FB28-4CC2-ADBF-1F8659F3****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ExistsServiceLinkedRole\\": true,\\n \\"RequestId\\": \\"90B82DB7-FB28-4CC2-ADBF-1F8659F3****\\"\\n}","type":"json"}]', 'title' => 'DescribeServiceLinkedRoleExists', 'description' => 'You can call this operation to query whether the service-lined role AliyunServiceRoleForKvstore is created for Tair (Redis OSS-compatible). For more information, see [Service-linked role of Tair (Redis OSS-compatible)](~~184337~~).'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeServiceLinkedRoleExists'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeServiceLinkedRoleExists', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeSlowLogRecords' => [ 'summary' => 'Queries the slow query logs of a Tair (Redis OSS-compatible) instance that are generated within a specified period of time.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56440', 'abilityTreeNodes' => ['FEATUREkvstoreS1FOWZ'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the node in the instance. You can set this parameter to query the slow query logs of a specified node.'."\n" ."\n" .'> This parameter is available only for read/write splitting and cluster instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-03-10T14:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. The time range cannot exceed one day. We recommend that you specify 1 hour. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-03-10T15:00Z', 'title' => ''], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return on each page. Valid values: **30**, **50**, and **100**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', 'enum' => ['30', '50', '100'], 'title' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The number of the page to return. The value must be an integer that is greater than **0**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'SlowLogRecordType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the slow logs. Default value: db. Valid values:'."\n" ."\n" .'* **proxy**: slow logs of proxy nodes'."\n" .'* **db**: slow logs of data nodes'."\n", 'type' => 'string', 'required' => false, 'example' => 'proxy', 'default' => 'db', 'enum' => ['proxy', 'db'], 'title' => '', ], ], [ 'name' => 'QueryKeyword', 'in' => 'query', 'schema' => ['description' => 'The keyword based on which slow logs are queried. You can set this parameter to a value of the string type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'keyword1', 'title' => ''], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => [ 'description' => 'The sorting order of the results to return. Default value: DESC. Valid values:'."\n" ."\n" .'* **ASC**: ascending order'."\n" .'* **DESC**: descending order'."\n", 'type' => 'string', 'required' => false, 'example' => 'ASC', 'default' => 'DESC', 'enum' => ['ASC', 'DESC'], 'title' => '', ], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => ['description' => 'The dimension by which to sort the results. Default value: execution_time. Valid values:'."\n" ."\n" .'* **execution_time**: sorts the results by query start time.'."\n" .'* **latency**: sorts the results by query latency.'."\n", 'type' => 'string', 'required' => false, 'example' => 'execution_time', 'default' => 'execution_time', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'The start time of the query.'."\n", 'type' => 'string', 'example' => '2019-03-10T14:00Z', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '686BB8A6-BBA5-47E5-8A75-D2ADE433****', 'title' => ''], 'PageRecordCount' => ['description' => 'The number of log entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of returned log entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The maximum number of log entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp10n********', 'title' => ''], 'Engine' => ['description' => 'The database engine that the instance runs.'."\n", 'type' => 'string', 'example' => 'Redis', 'title' => ''], 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'LogRecords' => [ 'description' => 'The slow query log entries.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Account' => ['description' => 'The ID of the account.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'ElapsedTime' => ['description' => 'The amount of time consumed to execute the slow query statement. Unit: microseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '248', 'title' => ''], 'Command' => ['description' => 'The slow query statement.'."\n", 'type' => 'string', 'example' => 'KEYS *', 'title' => ''], 'DBName' => ['description' => 'The database name.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'ExecuteTime' => ['description' => 'The start time when the slow query statement was executed. The time is displayed in the YYYY-MM-DDTHH:mm:ssZ format.'."\n", 'type' => 'string', 'example' => '2019-03-12T09:18:41Z', 'title' => ''], 'DataBaseName' => ['description' => 'The database name. This parameter serves the same purpose as the **DBName** parameter. We recommend that you use the **DBName** parameter.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], 'AccountName' => ['description' => 'The username of the account.'."\n", 'type' => 'string', 'example' => 'demo', 'title' => ''], 'IPAddress' => ['description' => 'The IP address of the client.'."\n", 'type' => 'string', 'example' => '172.16.88.***', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The Specified parameter StartTime is not valid.', 'description' => ''], ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The Specified parameter EndTime is not valid.', 'description' => ''], ], 403 => [ ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', 'description' => ''], ['errorCode' => 'ServerBusy', 'errorMessage' => 'server busy now, please retry later.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"StartTime\\": \\"2019-03-10T14:00Z\\",\\n \\"RequestId\\": \\"686BB8A6-BBA5-47E5-8A75-D2ADE433****\\",\\n \\"PageRecordCount\\": 1,\\n \\"TotalRecordCount\\": 1,\\n \\"PageSize\\": 30,\\n \\"InstanceId\\": \\"r-bp10n********\\",\\n \\"Engine\\": \\"Redis\\",\\n \\"PageNumber\\": 1,\\n \\"Items\\": {\\n \\"LogRecords\\": [\\n {\\n \\"Account\\": \\"0\\",\\n \\"ElapsedTime\\": 248,\\n \\"Command\\": \\"KEYS *\\",\\n \\"DBName\\": \\"0\\",\\n \\"ExecuteTime\\": \\"2019-03-12T09:18:41Z\\",\\n \\"DataBaseName\\": \\"0\\",\\n \\"NodeId\\": \\"r-bp1zxszhcgatnx****-db-0\\",\\n \\"AccountName\\": \\"demo\\",\\n \\"IPAddress\\": \\"172.16.88.***\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tKEYS *\\r\\n\\t\\t\\t2019-03-20T09:18:41Z\\r\\n\\t\\t\\t248\\r\\n\\t\\t\\t172.16.88.***\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t-1\\r\\n\\t\\t\\t-1\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t1\\r\\n\\t1\\r\\n\\t30\\r\\n\\tr-bp1zxszhcgatnx****-db-1\\r\\n\\t686BB8A6-BBA5-47E5-8A75-D2ADE433****\\r\\n\\t2019-03-10T13:11Z\\r\\n\\tRedis\\r\\n\\t1\\r\\n","errorExample":""}]', 'title' => 'DescribeSlowLogRecords', 'description' => 'You can also query slow logs in the Tair (Redis OSS-compatible) console. For more information, see [Query slow logs of an instance](~~95874~~). This operation can be called up to 100 times per minute.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-03-25T11:17:47.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSlowLogRecords'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeSlowLogRecords', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ], ], ], 'DescribeTags' => [ 'summary' => 'Queries all tags in a region.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56443', 'abilityTreeNodes' => ['FEATUREkvstore9GDS4D'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The resource type. Valid values: **INSTANCE** or **instance**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'INSTANCE', 'default' => 'INSTANCE', 'enum' => ['INSTANCE', 'instance'], 'title' => '', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n" ."\n" .'> This parameter is not required for the first request. If not all results are returned in one query, you can specify the token that is obtained from the previous query as the value of **NextToken**.'."\n", 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707ec2****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NextToken' => ['description' => 'The pagination token to use in the next request to get the next page. If this field is empty, there are no more results.'."\n" ."\n" .'> If not all results are returned in one query, this parameter is returned. You can pass in the returned value of this parameter for the next query.'."\n", 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707ec2****', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F3F44BE3-5419-4B61-9BAC-E66E295A****', 'title' => ''], 'Tags' => [ 'description' => 'The details of the tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the tag.'."\n", 'type' => 'object', 'properties' => [ 'TagKey' => ['description' => 'The key of the tag.'."\n", 'type' => 'string', 'example' => 'size', 'title' => ''], 'TagValues' => [ 'description' => 'The tag values.'."\n", 'type' => 'array', 'items' => ['description' => 'The value of the tag'."\n", 'type' => 'string', 'example' => '[\'test_value_2\']', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The specified parameter \'Tag.n.Key\' or \'TagKey.n\' is not valid.', 'description' => ''], ['errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The specified parameter \'Tag.n.Value\' is not valid.', 'description' => ''], ['errorCode' => 'InvalidParameter.ResourceId', 'errorMessage' => 'The specified parameter \'ResourceId.n\' is not valid.', 'description' => ''], ['errorCode' => 'MissParameter.TagOrResourceId', 'errorMessage' => 'The parameter \'Tag.n\'\' or \'ResourceId.n\' is needed.', 'description' => ''], ['errorCode' => 'InvalidParameter.Scope', 'errorMessage' => 'The specified parameter \'Scope\' is not valid.', 'description' => ''], ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', 'description' => ''], ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter\'s number is exceed.', 'description' => ''], ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The specified parameter \'Tag.n.Key\' is duplicated.', 'description' => ''], ['errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The specified parameter \'ResourceType\' is not valid.', 'description' => ''], ], 404 => [ ['errorCode' => 'InvalidDbInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', 'description' => ''], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707ec2****\\",\\n \\"RequestId\\": \\"F3F44BE3-5419-4B61-9BAC-E66E295A****\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"size\\",\\n \\"TagValues\\": [\\n \\"[\'test_value_2\']\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeTags', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTags'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeTags', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeTairKVCacheInferInstances' => [ 'summary' => 'Queries information about one or more Tair KVCache instances.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '265688', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the instances that you want to query.'."\n" .'> To specify multiple instance IDs, separate them with commas (,). You can specify up to 30 instance IDs in a single request.', 'type' => 'string', 'required' => false, 'example' => 'tk-2zefe7728c2c****', 'title' => ''], ], [ 'name' => 'InstanceStatus', 'in' => 'query', 'schema' => ['description' => 'The instance status. Valid values:'."\n" .'* **Normal**: Normal.'."\n" .'* **Creating**: The instance is being created.'."\n" ."\n" .'> For more information about instance statuses, see [Instance states and impacts](~~200740~~).', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" .'- **PrePaid**: subscription.'."\n" .'- **PostPaid**: pay-as-you-go.', 'type' => 'string', 'required' => false, 'enum' => ['PrePaid', 'PostPaid'], 'example' => 'PrePaid', 'title' => '', ], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type. Valid values:'."\n" .'* **VPC**: virtual private cloud (VPC). This is the default value.', 'type' => 'string', 'required' => false, 'enum' => ['CLASSIC', 'VPC'], 'example' => 'VPC', 'title' => '', ], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => ['description' => 'The instance type.', 'type' => 'string', 'required' => false, 'example' => 'kvcache.cu.g4c.2', 'title' => ''], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value starts from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '0', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'SearchKey', 'in' => 'query', 'schema' => ['description' => 'The keyword used for fuzzy search by instance name or instance ID.', 'type' => 'string', 'required' => false, 'example' => 'apitest', 'title' => ''], ], [ 'name' => 'Expired', 'in' => 'query', 'schema' => ['description' => 'The expiration status of the instance. Valid values:'."\n" ."\n" .'* **true**: expired.'."\n" .'* **false**: not expired.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-e', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID. This parameter can be left empty.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags of the instance.', 'type' => 'array', 'items' => [ 'description' => 'The tags of the instance.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag. The key and value of a tag form a key-value pair.'."\n" .'> You can specify up to 5 key-value pairs of tags in a single request.', 'type' => 'string', 'required' => false, 'example' => 'key1_test', 'title' => ''], 'Value' => ['description' => 'The value of the tag.'."\n" .'> **N** specifies the sequence number of the tag. For example, **Tag.1.Value** specifies the value of the first tag, and **Tag.2.Value** specifies the value of the second tag.', 'type' => 'string', 'required' => false, 'example' => 'testvalue', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], [ 'name' => 'PrivateIp', 'in' => 'query', 'schema' => ['description' => 'The private IP address in the VPC. This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '172.16.49.***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CD225838-7069-5CE4-89E1-67B83AC149C8', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'Instances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TairInferInstanceDTO' => [ 'description' => 'The list of Tair KVCache instances.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-2zef5w848p4j5g***', 'title' => ''], 'CreateTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2025-04-07T04:46Z', 'title' => ''], 'ChargeType' => ['description' => 'The billing method.', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''], 'NetworkType' => ['description' => 'The network type.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'kvcache-7', 'title' => ''], 'InstanceClass' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'kvcache.cu.g4b.2', 'title' => ''], 'DestroyTime' => ['description' => 'The time when the instance was destroyed.', 'type' => 'string', 'example' => '2025-04-07T04:46Z'."\n", 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'tk-9dp7e37bab*****', 'title' => ''], 'InstanceType' => ['description' => 'The instance type. Valid values:'."\n" .'* **TairInfer**: inference operator instance.'."\n" .'* **TairKVCacheVnode**: virtual cluster instance.'."\n" .'* **TairKVCacheService**: cache service instance.', 'type' => 'string', 'example' => 'TairInfer', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'EndTime' => ['description' => 'The time when the upfront instance expires.', 'type' => 'string', 'example' => '2025-11-04T02:09:26Z', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-8vbf0ksk774ai6q1d****', 'title' => ''], 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfm4bdru5z****', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-g', 'title' => ''], 'InstanceStatus' => ['description' => 'The instance status. Valid values:'."\n" .'* **Normal**: Normal.'."\n" .'* **Creating**: The instance is being created.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The tags of the instance.', 'type' => 'array', 'items' => [ 'description' => 'The tags of the instance.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'thread', 'title' => ''], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => '900', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'PrivateIp' => ['description' => 'The private IP address in the VPC. This parameter is deprecated.', 'type' => 'string', 'example' => '172.16.49.***', 'title' => ''], 'Capacity' => ['description' => 'The KVCache storage capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '256', 'title' => ''], 'Model' => ['description' => 'The built-in model of the inference operator instance.', 'type' => 'string', 'example' => 'DeepSeek-OCR', 'title' => ''], 'ModelServiceNum' => ['description' => 'The number of model services for the inference operator instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ComputeUnitNum' => ['description' => 'The number of compute units.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'VNodeName' => ['description' => 'The list of VNode instance names under the virtual cluster instance. This parameter is deprecated.', 'type' => 'string', 'example' => 'tv-xxxxx', 'title' => ''], 'AckId' => ['description' => 'The ACK ID associated with the virtual cluster instance.', 'type' => 'string', 'example' => 'c809******************************', 'title' => ''], 'VNodeCount' => ['description' => 'The number of virtual nodes in the virtual cluster instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'FixedVNodeCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'ElasticVNodeCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidInstanceIds.Malformed', 'errorMessage' => 'The Specified parameter InstanceIds is not valid.', 'description' => ''], ], ], 'title' => 'Query tair kVCache instances', 'description' => 'This operation supports querying Tair KVCache inference operator instances, virtual cluster instances, and cache service instances.', 'changeSet' => [ ['createdAt' => '2025-12-04T14:07:01.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTairKVCacheInferInstances'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'kvstore:DescribeTairKVCacheInferInstances', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD225838-7069-5CE4-89E1-67B83AC149C8\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"TotalCount\\": 3,\\n \\"Instances\\": {\\n \\"TairInferInstanceDTO\\": [\\n {\\n \\"VpcId\\": \\"vpc-2zef5w848p4j5g***\\",\\n \\"CreateTime\\": \\"2025-04-07T04:46Z\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"InstanceName\\": \\"kvcache-7\\",\\n \\"InstanceClass\\": \\"kvcache.cu.g4b.2\\",\\n \\"DestroyTime\\": \\"2025-04-07T04:46Z\\\\n\\",\\n \\"InstanceId\\": \\"tk-9dp7e37bab*****\\",\\n \\"InstanceType\\": \\"TairInfer\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"EndTime\\": \\"2025-11-04T02:09:26Z\\",\\n \\"VSwitchId\\": \\"vsw-8vbf0ksk774ai6q1d****\\",\\n \\"ResourceGroupId\\": \\"rg-acfm4bdru5z****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-g\\",\\n \\"InstanceStatus\\": \\"Normal\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"thread\\",\\n \\"Value\\": \\"900\\"\\n }\\n ]\\n },\\n \\"PrivateIp\\": \\"172.16.49.***\\",\\n \\"Capacity\\": 256,\\n \\"Model\\": \\"DeepSeek-OCR\\",\\n \\"ModelServiceNum\\": 1,\\n \\"ComputeUnitNum\\": 1,\\n \\"VNodeName\\": \\"tv-xxxxx\\",\\n \\"AckId\\": \\"c809******************************\\",\\n \\"VNodeCount\\": 2,\\n \\"FixedVNodeCount\\": 0,\\n \\"ElasticVNodeCount\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeTairSkvDdbTable' => [ 'summary' => 'Queries all Tair Serverless KV table instances in a specified workspace.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56403', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tt-bp1zxszhcgatnx\\*\\*\\*\\*', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '2363CEDF-C697-14B6-AB9E-C57A4AA0EAD4', 'title' => ''], 'Tables' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Table' => [ 'description' => 'The array of Table objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TableId' => ['description' => 'The table ID, which is globally unique.', 'type' => 'string', 'example' => 'tt-2zelkttksbyc12x6c', 'title' => ''], 'TableName' => ['description' => 'The table name, which is unique within the workspace.', 'type' => 'string', 'example' => 'table1', 'title' => ''], 'Bandwidth' => ['description' => 'The bandwidth.', 'type' => 'integer', 'format' => 'int64', 'example' => '96', 'title' => ''], 'Connections' => ['description' => 'The maximum number of connections.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query tair serverless KV table instances', 'description' => '## Operation description'."\n" ."\n" .'- You must specify the InstanceId parameter when you call this operation.'."\n" .'- The response includes basic information about each table, such as the table ID, name, bandwidth, and maximum number of connections.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeTairSkvDdbTable', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2363CEDF-C697-14B6-AB9E-C57A4AA0EAD4\\",\\n \\"Tables\\": {\\n \\"Table\\": [\\n {\\n \\"TableId\\": \\"tt-2zelkttksbyc12x6c\\",\\n \\"TableName\\": \\"table1\\",\\n \\"Bandwidth\\": 96,\\n \\"Connections\\": 1000\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeTairSkvDdbTableSchema' => [ 'summary' => 'Retrieves the table schema and configuration information of a specified instance.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56403', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tt-bp1zxszhcgatnx\\\\*\\\\*\\\\*\\\\*', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup file.', 'type' => 'string', 'required' => false, 'example' => '78241****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID. For more information, see common parameters.', 'type' => 'string', 'example' => 'A1604E1B-6825-1577-BBDA-2A64E8D5F126', 'title' => ''], 'Schema' => ['description' => 'The table schema information in JSON format.', 'type' => 'string', 'example' => '{"attributeDefinitions":[{"attributeType":"S","attributeName":"pk"},{"attributeType":"S","attributeName":"sk"}],"keySchema":[{"attributeName":"pk","keyType":"HASH"},{"attributeName":"sk","keyType":"RANGE"}]}', 'title' => ''], 'TtlSpec' => ['description' => 'The TTL property. The parameter settings toggle in JSON format.', 'type' => 'string', 'example' => '{"attributeName":"Expiretime","enabled":true}', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query tair serverless KV table schema', 'description' => '## Operation description'."\n" .'- This operation queries the table schema and configuration information of a Tair Serverless KV table instance.'."\n" .'- You must specify the InstanceId parameter. Set this parameter to the instance ID of the instance that you want to query.'."\n" .'- The BackupId parameter specifies the backup set of the table to query.'."\n" .'- The response packet includes the time-to-live (TTL) specifications and detailed table schema definition.'."\n" ."\n" .'To invoke this operation, see the request parameters below.', 'responseParamsDescription' => '```'."\n" .'{'."\n" .' "TtlSpec":"{\\"attributeName\\":\\"Expiretime\\",\\"enabled\\":true}",'."\n" .' "RequestId":"A1604E1B-6825-1577-BBDA-2A64E8D5F126",'."\n" .' "Schema":"{\\"attributeDefinitions\\":[{\\"attributeType\\":\\"S\\",\\"attributeName\\":\\"pk\\"},{\\"attributeType\\":\\"S\\",\\"attributeName\\":\\"sk\\"}],\\"keySchema\\":[{\\"attributeName\\":\\"pk\\",\\"keyType\\":\\"HASH\\"},{\\"attributeName\\":\\"sk\\",\\"keyType\\":\\"RANGE\\"}]}"'."\n" .' }'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeTairSkvDdbTableSchema', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1604E1B-6825-1577-BBDA-2A64E8D5F126\\",\\n \\"Schema\\": \\"{\\\\\\"attributeDefinitions\\\\\\":[{\\\\\\"attributeType\\\\\\":\\\\\\"S\\\\\\",\\\\\\"attributeName\\\\\\":\\\\\\"pk\\\\\\"},{\\\\\\"attributeType\\\\\\":\\\\\\"S\\\\\\",\\\\\\"attributeName\\\\\\":\\\\\\"sk\\\\\\"}],\\\\\\"keySchema\\\\\\":[{\\\\\\"attributeName\\\\\\":\\\\\\"pk\\\\\\",\\\\\\"keyType\\\\\\":\\\\\\"HASH\\\\\\"},{\\\\\\"attributeName\\\\\\":\\\\\\"sk\\\\\\",\\\\\\"keyType\\\\\\":\\\\\\"RANGE\\\\\\"}]}\\",\\n \\"TtlSpec\\": \\"{\\\\\\"attributeName\\\\\\":\\\\\\"Expiretime\\\\\\",\\\\\\"enabled\\\\\\":true}\\"\\n}","type":"json"}]', ], 'DescribeTaskDetail' => [ 'summary' => '', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => '674546459', 'description' => '', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****'], 'Status' => [ 'type' => 'string', 'description' => '', 'enumValueTitles' => ['COMPLETED' => 'COMPLETED', 'RUNNING' => 'RUNNING'], 'example' => 'RUNNING', 'title' => '', ], 'BeginTime' => ['type' => 'string', 'description' => '', 'example' => '2026-05-12T07:18:57Z', 'title' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"561AFBF1-BE20-44DB-9BD1-6988B53E****\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"BeginTime\\": \\"2026-05-12T07:18:57Z\\"\\n}","type":"json"}]', ], 'DescribeZones' => [ 'summary' => 'Queries the zones that support Tair (Redis OSS-compatible) in a specific region. To query the zones where Tair (Redis OSS-compatible) instances can be purchased, call the DescribeAvailableResource operation.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56451', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-huhehaote', 'title' => ''], ], [ 'name' => 'AcceptLanguage', 'in' => 'query', 'schema' => ['description' => 'The display language of the zone names to return. Valid values:'."\n" ."\n" .'* **zh-CN** (default): Chinese'."\n" .'* **en-US**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'en-US', 'default' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1D42F072-72FE-4DC4-BB8E-64B1D298****', 'title' => ''], 'Zones' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'KVStoreZone' => [ 'description' => 'The queried zones.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'IsRds' => ['description' => 'Indicates whether the zone is managed by ApsaraDB RDS. The return value of this parameter is **true** in Tair (Redis OSS-compatible).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ZoneId' => ['description' => 'The ID of the zone within the specified region.'."\n", 'type' => 'string', 'example' => 'cn-huhehaote-b', 'title' => ''], 'Disabled' => ['description' => 'Indicates whether Tair (Redis OSS-compatible) instances can be created in the current zone. Valid values:'."\n" ."\n" .'* **true**: Tair (Redis OSS-compatible) instances cannot be created in the current zone.'."\n" .'* **false**: Tair (Redis OSS-compatible) instances can be created in the current zone.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'SwitchNetwork' => ['description' => 'Indicates whether the network type of the instance can be changed from the classic network to Virtual Private Cloud (VPC). Valid values:'."\n" ."\n" .'* **true**: The network type of the instance can be changed from the classic network to VPC.'."\n" .'* **false**: The network type of the instance cannot be changed from the classic network to VPC.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ZoneName' => ['description' => 'The name of the zone within the specified region.'."\n", 'type' => 'string', 'example' => '呼和浩特 可用区B', 'title' => ''], 'RegionId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-huhehaote', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1D42F072-72FE-4DC4-BB8E-64B1D298****\\",\\n \\"Zones\\": {\\n \\"KVStoreZone\\": [\\n {\\n \\"IsRds\\": true,\\n \\"ZoneId\\": \\"cn-huhehaote-b\\",\\n \\"Disabled\\": true,\\n \\"SwitchNetwork\\": true,\\n \\"ZoneName\\": \\"呼和浩特 可用区B\\",\\n \\"RegionId\\": \\"cn-huhehaote\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => 'DescribeZones', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-05-08T09:40:55.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZones'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [], ], 'DestroyInstance' => [ 'summary' => 'Permanently destroys instances and their data backups in the recycle bin.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '56452', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance in the recycle bin.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-8vb2rhccnvd82f****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '870422DE-B64C-5A15-9C48-4A9485D1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"870422DE-B64C-5A15-9C48-4A9485D1****\\"\\n}","type":"json"}]', 'title' => 'DestroyInstance', 'description' => 'Before you call this operation, instances must be available in the recycle bin. For more information, see [Instance recycle bin](~~86114~~).'."\n" ."\n" .'> Calling this operation permanently deletes the instances and their data backups in the recycle bin.'."\n" ."\n" .'**'."\n" ."\n" .'**Warning** After you destroy the instance, data in the instance is permanently deleted and can no longer be restored. Proceed with caution.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DestroyInstance'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DestroyInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'EnableAdditionalBandwidth' => [ 'summary' => 'This operation adjusts the bandwidth for an ApsaraDB for Redis instance that uses the pay-as-you-go billing method. You need to specify only the InstanceId, NodeId (optional), Bandwidth, and ChargeType parameters.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '56453', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. You can call the [DescribeInstances](~~473778~~) operation to query the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => ['description' => 'The coupon ID.', 'type' => 'string', 'required' => false, 'default' => 'youhuiquan_promotion_option_id_for_blank', 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-payment. Valid values:'."\n" ."\n" .'- **true**: Enables auto-payment. This is the default. Ensure that your account has a sufficient balance.'."\n" ."\n" .'- **false**: Disables auto-payment. You must manually complete the payment.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'default' => 'true', 'example' => 'true', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the data shard. You can call the [DescribeLogicInstanceTopology](~~473786~~) operation to query data shard IDs. Separate multiple data shard IDs with commas (,). You can also set this parameter to **All** to specify all data shards.'."\n" ."\n" .'> This parameter is required only when the instance uses the [cluster architecture](~~52228~~) or the [read/write splitting architecture](~~62870~~).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'default' => '', 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], ], [ 'name' => 'Bandwidth', 'in' => 'query', 'schema' => ['description' => 'The amount of bandwidth to add, in MB/s. The value must be an integer greater than or equal to **0**. The maximum value is six times the default bandwidth of the instance type or a single data shard, with an upper limit of 192 MB/s. For example, if the default bandwidth of an instance is 10 MB/s, the valid values for this parameter are **0** to **60**.'."\n" ."\n" .'> - You can call the [DescribeRoleZoneInfo](~~473782~~) operation and check the value of the **DefaultBandWidth** parameter in the response to get the default maximum bandwidth. For more information about instance types, see [Instance types](~~26350~~).'."\n" .'>'."\n" .'> - If you specified multiple data shard IDs for the **NodeId** parameter, the bandwidth values that you specify for this parameter must correspond to the order of the data shard IDs. Separate multiple bandwidth values with commas (,).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '20', 'title' => ''], ], [ 'name' => 'OrderTimeLength', 'in' => 'query', 'schema' => ['description' => 'The subscription duration, in days. Valid values: **1**, **2**, **3**, **7**, **14**, **30**, **60**, **90**, **180**, **365**, **730**, **1095**, and **1825**.'."\n" ."\n" .'> To continue using the purchased bandwidth, you must call the [RenewAdditionalBandwidth](~~473804~~) operation to renew the bandwidth before it expires.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'default' => '1', 'example' => '30', 'title' => ''], ], [ 'name' => 'SourceBiz', 'in' => 'query', 'schema' => ['description' => 'The source of the call. This parameter is used for internal maintenance. Do not specify it.', 'type' => 'string', 'required' => false, 'example' => 'SDK', 'title' => ''], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" ."\n" .'- **true**: Enables auto-renewal.'."\n" ."\n" .'- **false**: Disables auto-renewal. This is the default.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => ['description' => 'The auto-renewal period, in months. Valid values: **1**, **2**, **3**, **4**, **5**, **6**, **7**, **8**, **9**, **12**, **24**, **36**, and **60**.'."\n" ."\n" .'> - This parameter is required only when **AutoRenew** is set to **true**.'."\n" .'>'."\n" .'> - After you set this parameter, you cannot query its value by calling API operations. To check this setting, go to the console. In the top navigation bar, choose **Billing** > **Renewal Management**. Then, in the **Instance ID** field, enter the instance ID followed by the `-bw` suffix (for example, r-bp1zxszhcgatnx\\*\\*\\*\\*-bw).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method for the additional bandwidth. Valid values:'."\n" ."\n" .'- **PrePaid**: subscription.'."\n" ."\n" .'- **PostPaid**: pay-as-you-go. This is the only supported billing method.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'enum' => ['PostPaid', 'PrePaid'], 'example' => 'PrePaid', 'title' => '', ], ], [ 'name' => 'BandWidthBurst', 'in' => 'query', 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2084452111111', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], ], 'description' => 'The response parameters.', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"2084452111111\\",\\n \\"RequestId\\": \\"D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","type":"json"}]', 'title' => 'EnableAdditionalBandwidth', 'description' => 'If auto scaling of bandwidth is enabled when you call this operation, the auto scaling feature takes precedence. When the bandwidth scales back, it reverts to the default bandwidth of the instance type. For more information about the feature\'s limitations, billing details, and FAQ, see [Adjust instance bandwidth](~~102588~~).'."\n" ."\n" .'> Before you call this operation, you can call the [DescribeRoleZoneInfo](~~473782~~) operation to query the current bandwidth for each data node of the instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-12-12T02:45:35.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-06T08:07:31.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EnableAdditionalBandwidth'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:EnableAdditionalBandwidth', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'FlushExpireKeys' => [ 'summary' => 'Clears all expired keys in a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want to delete the expired keys. Default value: Immediately. Valid values:'."\n" ."\n" .'* **Immediately**: deletes the keys immediately.'."\n" .'* **MaintainTime**: deletes the keys during the maintenance window.'."\n" ."\n" .'> You can call the [ModifyInstanceMaintainTime](~~473775~~) operation to modify the maintenance window of an instance.', 'type' => 'string', 'required' => false, 'example' => 'Immediately', 'default' => '0', 'enum' => ['Immediately', 'MaintainTime'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '82E30AB7-E3A4-46AC-88A0-3E4DCDC5****', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '21986****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"82E30AB7-E3A4-46AC-88A0-3E4DCDC5****\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"TaskId\\": \\"21986****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n r-bp1zxszhcgatnx****\\n 82E30AB7-E3A4-46AC-88A0-3E4DCDC5****\\n 21986****\\n","errorExample":""}]', 'title' => 'FlushExpireKeys', 'description' => 'For more information about how to clear the expired keys in the Tair (Redis OSS-compatible) console, see [Clear data](~~43881~~).'."\n" ."\n" .'> Expired keys cannot be recovered after they are deleted. Exercise caution when you call this operation.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-07-20T02:32:40.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'FlushExpireKeys'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:FlushExpireKeys', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ], ], ], 'FlushInstance' => [ 'summary' => 'Clears the data of a Tair (Redis OSS-compatible) instance. The cleared data cannot be restored.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The operation that you want to perform. Set the value to **FlushInstance**.'."\n", 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E7', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E7\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E7\\"\\n}"},{"type":"xml","example":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\n","errorExample":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\n"}]', 'title' => 'FlushInstance', 'description' => '该API对应的控制台操作请参见[清除数据](~~43881~~)。'."\n" ."\n" .'> 调用此API删除数据前请妥善备份数据或确认数据无需备份。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-04-26T08:33:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FlushInstance'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:FlushInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'FlushInstanceForDB' => [ 'summary' => 'Cleans the data of specified databases in a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'DbIndex', 'in' => 'query', 'schema' => ['description' => 'The index number of the database. Valid values: 0 to 255.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","type":"json"}]', 'title' => 'FlushInstanceForDB', 'description' => 'Each Tair (Redis OSS-compatible) instance can contain up to 256 databases named from DB0 to DB255. Each database does not have a separate memory usage limit. The memory capacity that a database can use is subject to the total memory limit of the instance. You can execute the `SELECT` statement to switch between databases. For more information, see [What is the size of each database on a Tair (Redis OSS-compatible) instance, and how can I choose databases?](~~38688~~)'."\n" ."\n" .'> This operation is available only for cloud-native instances that use cloud disks.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FlushInstanceForDB'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:FlushInstanceForDB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GrantAccountPrivilege' => [ 'summary' => 'Modifies the permissions of an account for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56458', 'abilityTreeNodes' => ['FEATUREkvstoreXSBQ72'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance to which the account belongs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The name of the account. You can call the [DescribeAccounts](~~DescribeAccounts~~) operation to obtain the name of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'demoaccount', 'title' => ''], ], [ 'name' => 'AccountPrivilege', 'in' => 'query', 'schema' => ['description' => 'The permissions of the account. Default value: RoleReadWrite. Valid values:'."\n" ."\n" .'* RoleReadOnly: The account has the read-only permissions.'."\n" .'* RoleReadWrite: The account has the read and write permissions.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RoleReadWrite', 'title' => ''], ], [ 'name' => 'SourceBiz', 'in' => 'query', 'schema' => ['description' => 'This parameter is used only for internal maintenance. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SDK', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3845BDF5-15A6-4444-B770-78501819****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAccountName.Format', 'errorMessage' => 'Specified AccountName is not valid.', 'description' => ''], ['errorCode' => 'InvalidAccountPrivilege.Format', 'errorMessage' => 'Specified AccountPrivilege is not valid.', 'description' => ''], ['errorCode' => 'IncorrectAccount', 'errorMessage' => 'Current DB instance account does not support this operation.', 'description' => ''], ['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'The operation is not supported by the minor version of the instance. Update the instance to the latest minor version and try again.'], ], 404 => [ ['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified AccountName does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3845BDF5-15A6-4444-B770-78501819****\\"\\n}","errorExample":"{\\n\\t\\"RequestId\\": \\"3845BDF5-15A6-4444-B770-785018191E25\\"\\n}"},{"type":"xml","example":"\\n 3845BDF5-15A6-4444-B770-78501819****\\n","errorExample":"\\n 3845BDF5-15A6-4444-B770-785018191E25\\n"}]', 'title' => 'GrantAccountPrivilege', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-07-11T12:25:18.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GrantAccountPrivilege'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:GrantAccountPrivilege', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'description' => '> '."\n" ."\n" .'* Only Tair (Redis OSS-compatible) instances of Redis 4.0 or later are supported.'."\n" .'* The Tair (Redis OSS-compatible) instance must be in the running state.', ], 'InitializeKvstorePermission' => [ 'summary' => 'Assigns a service-linked role to Tair (Redis OSS-compatible).', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'default' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D2****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D2****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t5D622714-AEDD-4609-9167-F5DDD3D1****\\r\\n","errorExample":""}]', 'title' => 'InitializeKvstorePermission', 'description' => 'The log management feature of Tair (Redis OSS-compatible) requires the resources of [Simple Log Service](~~48869~~). To use the log management feature, you can call this operation to assign the AliyunServiceRoleForKvstore service-linked role to Tair (Redis OSS-compatible). For more information, see [Service-linked role of Tair (Redis OSS-compatible)](~~184337~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-03-02T02:42:53.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitializeKvstorePermission'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:InitializeKvstorePermission', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListTagResources' => [ 'summary' => 'Queries the relationships between Tair (Redis OSS-compatible) instances and tags.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56460', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreZ21KYW', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The resource type. Set the value to **INSTANCE**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', 'enum' => ['INSTANCE', 'instance'], 'title' => '', ], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The token used to start the next query to retrieve more results.'."\n" ."\n" .'> This parameter is not required in the first query. If not all results are returned in one query, you can specify the **NextToken** value returned for the query to perform the next query.'."\n", 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707ec2****', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the instances.'."\n" ."\n" .'> * You must specify this parameter or the **Tag** parameter.', 'type' => 'array', 'items' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'maxItems' => 51, 'title' => '', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags of the instance. You must specify this parameter or the **ResourceId** parameter.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The keys of the tags associated with the instances you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'demokey', 'title' => ''], 'Value' => ['description' => 'The values of the tags associated with the instances you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'demovalue', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'NextToken' => ['description' => 'The token required to obtain more results. If a query does not return all results, in the next query, you can provide the token returned by the previous query to obtain more results.'."\n", 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707ec2****', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '47A514A1-4B77-4E30-B4C5-2A880650****', 'title' => ''], 'TagResources' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TagResource' => [ 'description' => 'Details about the instances and tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag that is added to the instance.'."\n", 'type' => 'object', 'properties' => [ 'TagValue' => ['description' => 'The values of the tags.'."\n", 'type' => 'string', 'example' => 'demovalue', 'title' => ''], 'ResourceType' => ['description' => 'The resource type. The return value is **ALIYUN::KVSTORE::INSTANCE**. This value indicates a Tair (Redis OSS-compatible) instance.'."\n", 'type' => 'string', 'example' => 'ALIYUN::KVSTORE::INSTANCE', 'title' => ''], 'ResourceId' => ['description' => 'The resource ID, which is also the ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'TagKey' => ['description' => 'The keys of the tags.'."\n", 'type' => 'string', 'example' => 'demokey', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Key or TagKey.n is not valid.', 'description' => ''], ['errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Value is not valid.', 'description' => ''], ['errorCode' => 'InvalidParameter.ResourceId', 'errorMessage' => 'The specified parameter ResourceId.n is not valid.', 'description' => ''], ['errorCode' => 'MissParameter.TagOrResourceId', 'errorMessage' => 'The parameter Tag.n or ResourceId.n is needed.', 'description' => 'The parameters Tag and ResourceId cannot all be empty. At least one of them is passed in.'], ['errorCode' => 'InvalidParameter.Scope', 'errorMessage' => 'The specified parameter Scope is not valid.', 'description' => ''], ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter number is exceed.', 'description' => ''], ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter 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' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"212db86sca4384811e0b5e8707ec2****\\",\\n \\"RequestId\\": \\"47A514A1-4B77-4E30-B4C5-2A880650****\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"TagValue\\": \\"demovalue\\",\\n \\"ResourceType\\": \\"ALIYUN::KVSTORE::INSTANCE\\",\\n \\"ResourceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"TagKey\\": \\"demokey\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n ALIYUN::KVSTORE::INSTANCE\\n demovalue1\\n r-bp1zxszhcgatnx****\\n demokey1\\n \\n \\n ALIYUN::KVSTORE::INSTANCE\\n demovalue1\\n r-bp1zxszhcgatnx****\\n demokey1\\n \\n \\n ALIYUN::KVSTORE::INSTANCE\\n demovalue2\\n r-bp1zxszhcgatnx****\\n demokey2\\n \\n \\n ALIYUN::KVSTORE::INSTANCE\\n demovalue2\\n r-bp1zxszhcgatnx****\\n demokey2\\n \\n \\n 47A514A1-4B77-4E30-B4C5-2A880650****\\n","errorExample":""}]', 'title' => 'ListTagResources', 'description' => 'You can also query the relationships between instances and tags in the Tair (Redis OSS-compatible) console. For more information, see [Filter Tair (Redis OSS-compatible) instances by tag](~~119160~~) and [View tags bound to an instance](~~134038~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:ListTagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/*'], ], ], ], ], ], 'LockDBInstanceWrite' => [ 'summary' => 'Locks an instance. After the instance is locked, you can only read data from the instance, but cannot write data to the instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '192854', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'LockReason', 'in' => 'query', 'schema' => ['description' => 'The reason why write operations on the instance are locked.'."\n", 'type' => 'string', 'required' => true, 'example' => '锁写操作验证。', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****'], 'DBInstanceName' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-2ev03avw0r0552***', 'title' => ''], 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '21986****', 'title' => ''], 'LockReason' => ['description' => 'The reason why write operations on the instance are locked.'."\n", 'type' => 'string', 'example' => '锁定写操作测试。', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BE6E619-A657-42E3-AD2D-18F8428A****\\",\\n \\"DBInstanceName\\": \\"r-2ev03avw0r0552***\\",\\n \\"TaskId\\": 0,\\n \\"LockReason\\": \\"锁定写操作测试。\\"\\n}","type":"json"}]', 'title' => 'LockDBInstanceWrite', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockDBInstanceWrite'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:LockDBInstanceWrite', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'MasterNodeShutDownFailOver' => [ 'summary' => 'Simulates database node failures.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '240096', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'FailMode', 'in' => 'query', 'schema' => [ 'description' => '* **Hard**: stimulates a hardware failure that cannot be recovered. In this case, a high-availability switchover is triggered.'."\n" .'* **Soft** (default): stimulates a hardware failure that can be recovered. In this case, the system first attempts to recover the faulty node. If the attempt fails, a high-availability switchover is triggered.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* Safe'."\n" .'* UnSafe'."\n" .'* Hard'."\n" .'* Soft'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => ['UnSafe' => '', 'Hard' => 'Hard', 'Safe' => '', 'Soft' => 'Soft'], 'example' => 'Hard', 'default' => 'Safe', 'enum' => ['Safe', 'UnSafe', 'Hard', 'Soft'], 'title' => '', ], ], [ 'name' => 'DBNodes', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of the database nodes.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'r-rdsdavinx01003-db-0,r-rdsdavinx01003-db-1', 'title' => '', ], ], [ 'name' => 'ProxyInstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of the proxy nodes.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => '6981,6982', 'title' => '', ], ], [ 'name' => 'ProxyFaultMode', 'in' => 'query', 'schema' => [ 'description' => '* Specify: This mode allows you to specify a proxy node to use.'."\n" .'* Random: In this mode, a random proxy node is selected when no proxy node is specified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Specify', 'enum' => ['Specify', 'Random'], 'title' => '', ], ], [ 'name' => 'DBFaultMode', 'in' => 'query', 'schema' => [ 'description' => '* Specify: This mode allows you to specify a database node to use.'."\n" .'* Random: In this mode, a random database node is selected when no database node is specified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Random', 'enum' => ['Specify', 'Random'], 'title' => '', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. You can call the [DescribeInstances](~~473778~~) operation to query the instance ID.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => ['description' => 'The resource category. Set the value to instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'instance', 'default' => 'instance', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '12123216-4B00-4378-BE4B-08005BFC****'], 'DBInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'TaskID' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '17566', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12123216-4B00-4378-BE4B-08005BFC****\\",\\n \\"DBInstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"TaskID\\": \\"17566\\"\\n}","type":"json"}]', 'title' => 'MasterNodeShutDownFailOver', 'description' => '- 调用本接口时，指定的节点会关闭。实例会自动触发主备切换，将备节点提升为主节点。'."\n" .'- 模拟故障的节点会在稍后自动恢复。'."\n" .'- 单节点（单副本）不支持调用本接口。', 'changeSet' => [ ['createdAt' => '2025-09-15T05:58:42.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-11-12T09:28:36.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1', 'countWindow' => 30, 'regionId' => '*', 'api' => 'MasterNodeShutDownFailOver'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'kvstore:MasterNodeShutDownFailOver', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'MigrateToOtherZone' => [ 'summary' => 'Migrates a Tair (Redis OSS-compatible) instance to another zone in the same region.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56462', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Tair (Redis OSS-compatible) instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the destination primary zone. You can call the [DescribeZones](~~473764~~) operation to query zone IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou-g', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch.'."\n" ."\n" .'> '."\n" ."\n" .'* The zone where the vSwitch resides must be the same as the ID of the destination zone.'."\n" ."\n" .'* If the network type of the instance is VPC, this parameter is required.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1e7clcw529l773d****', 'default' => 'OpenApi', 'title' => ''], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when the database is switched after the instance is migrated. Valid values:'."\n" ."\n" .'* **Immediately**: The database is immediately switched after the instance is migrated.'."\n" .'* **MaintainTime**: The database is switched within the maintenance window.'."\n" ."\n" .'> Default value: Immediately.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Immediately', 'default' => '0', 'enum' => ['0', '1', 'Immediately', 'MaintainTime'], 'title' => '', ], ], [ 'name' => 'SecondaryZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the secondary zone to which you want to migrate the instance. You can call the [DescribeZones](~~473764~~) operation to query zone IDs.'."\n" ."\n" .'> If you specify this parameter, the master node and replica node of the instance can be deployed in different zones and disaster recovery is implemented across zones. The instance can withstand failures in data centers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', 'title' => ''], ], [ 'name' => 'ReplicaCount', 'in' => 'query', 'schema' => ['description' => 'The number of replica nodes in the primary zone.'."\n" ."\n" .'> '."\n" ."\n" .'* The **ReplicaCount** and **SlaveReplicaCount** parameters are applicable only to cloud-native instances. When you migrate an instance to multiple zones, you can use these parameters to adjust the distribution of replica nodes in the primary and secondary zones of the instance. This operation does not allow you to increase or decrease the number of nodes. Therefore, the sum of the values of `ReplicaCount and SlaveReplicaCount` must be the same as that before the migration.'."\n" ."\n" .'* If you do not specify these parameters when you migrate an instance from a single zone to multiple zones, one replica node is migrated to the secondary zone, and all other replica nodes remain in the primary zone.'."\n" ."\n" .'* If the instance is a cluster instance, the preceding parameters indicate the number of replica nodes per shard in the primary and secondary zones of the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ 'name' => 'SlaveReplicaCount', 'in' => 'query', 'schema' => ['description' => 'The number of replica nodes in the secondary zone.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ 'name' => 'ReadOnlyCount', 'in' => 'query', 'schema' => ['description' => 'The number of read replicas in the primary zone.'."\n" ."\n" .'> '."\n" ."\n" .'* The **ReadOnlyCount** and **SlaveReadOnlyCount** parameters are applicable only to cloud-native instances for which read/write splitting is enabled. When you migrate an instance to multiple zones, you can use these parameters to adjust the distribution of read replicas in the primary and secondary zones of the instance. This operation does not allow you to increase or decrease the number of nodes. Therefore, the sum of the values of `ReadOnlyCount and SlaveReadOnlyCount` must be the same as that before the migration.'."\n" ."\n" .'* If you do not specify these parameters when you migrate an instance from a single zone to multiple zones, one read replica is migrated to the secondary zone, and all other read replicas remain in the primary zone.'."\n" ."\n" .'* If the instance is a cluster instance, the preceding parameters indicate the number of read replicas per shard in the primary and secondary zones of the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9', 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ 'name' => 'SlaveReadOnlyCount', 'in' => 'query', 'schema' => ['description' => 'The number of read replicas in the secondary zone.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9', 'minimum' => '0', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '29B0BF34-D069-4495-92C7-FA6D9452****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'NetworkType.NotSupport', 'errorMessage' => 'Specified network type does not support this operation.', 'description' => 'The operation cannot be performed on an instance that has a public endpoint or a private endpoint. Release the endpoint and try again.'], ['errorCode' => 'InstanceStatus.NotSupport', 'errorMessage' => 'Instance status does not support this operation.', 'description' => 'The error message returned because the operation is not supported while the instance is in the current state.'], ['errorCode' => 'MissingSwitchId', 'errorMessage' => 'VSwitchId is mandatory for this action.', 'description' => ''], ['errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify zone not support VPC.', 'description' => ''], ['errorCode' => 'InvalidReginAvzNotFound', 'errorMessage' => 'Specified user does not find the region and zone.', 'description' => ''], ['errorCode' => 'ClusterNotSupport', 'errorMessage' => 'The Specified cluster does not support.', 'description' => ''], ['errorCode' => 'InvalidVSwitchId.Mismatch', 'errorMessage' => 'The Specified vSwitchId does not matched VPC.', 'description' => ''], ['errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'The Specified Zone does not supported.', 'description' => ''], ], 404 => [ ['errorCode' => 'DBInstanceNotFound', 'errorMessage' => 'Specified instance does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke VPC service failed.', 'description' => ''], ['errorCode' => 'ZoneMigrationError.StillingRunning', 'errorMessage' => 'Zone migration task is still running.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29B0BF34-D069-4495-92C7-FA6D9452****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 29B0BF34-D069-4495-92C7-FA6D9452****\\r\\n","errorExample":"\\n 29B0BF34-D069-4495-92C7-FA6D94528A9E\\n"}]', 'title' => 'MigrateToOtherZone', 'description' => 'Before you call this operation, you must release the public endpoint (if any) of the instance. For more information, see [Migrate an instance across zones](~~106272~~).'."\n" ."\n" .'> '."\n" ."\n" .'* If the network type of an Tair (Redis OSS-compatible) instance is switched from classic network to Virtual Private Cloud (VPC), and the classic network endpoint is retained, you can migrate the instance across zones only after the classic network endpoint is released upon expiration.'."\n" ."\n" .'* After the instance is migrated, the endpoint of the instance remains unchanged. However, the virtual IP address (VIP) is changed. We recommend that you use the endpoint instead of the VIP to connect to the instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-02-19T09:15:46.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateToOtherZone'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:MigrateToOtherZone', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'ModifyAccountDescription' => [ 'summary' => 'Modifies the description of an account for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56463', 'abilityTreeNodes' => ['FEATUREkvstoreXSBQ72'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The username of the account. You can call the [DescribeAccounts](~~473816~~) operation to query the username of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'demoaccount', 'title' => ''], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the account.'."\n" ."\n" .'* The description must start with a letter and cannot start with `http://` or `https://`.'."\n" .'* The description can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" .'* The description must be 2 to 256 characters in length.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testescription', 'title' => ''], ], [ 'name' => 'SourceBiz', 'in' => 'query', 'schema' => ['description' => 'This parameter is automatically generated by the service, You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'SDK', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidEngineVersion.Format', 'errorMessage' => 'Current EngineVersion does not support operations.', 'description' => 'The operation is not supported while the instance runs this engine version.'], ['errorCode' => 'InvalidAccountDescription.Format', 'errorMessage' => 'Specified AccountDescription is not valid.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B****\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\"\\n}"},{"type":"xml","example":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B****\\n","errorExample":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\n"}]', 'title' => 'ModifyAccountDescription', 'description' => 'This operation is supported only for instances that run Redis 4.0 or later.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-07-11T12:25:18.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyAccountDescription', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'ModifyAccountPassword' => [ 'summary' => 'Modifies the password of an account for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56464', 'abilityTreeNodes' => ['FEATUREkvstoreXSBQ72'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The username of the account for which you want to change the password. You can call the [DescribeAccounts](~~473816~~) operation to query the username of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testaccount', 'title' => ''], ], [ 'name' => 'OldAccountPassword', 'in' => 'query', 'schema' => ['description' => 'The current password of the account.'."\n" .' '."\n" .'> If you forget your password, you can call the [ResetAccountPassword](~~473815~~) operation to reset your password.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'oldPassWd999****', 'title' => ''], ], [ 'name' => 'NewAccountPassword', 'in' => 'query', 'schema' => ['description' => 'The new password to be set for the account. The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and specific special characters. These special characters include `! @ # $ % ^ & * ( ) _ + - =`', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'newPassWd888****', 'title' => ''], ], [ 'name' => 'SourceBiz', 'in' => 'query', 'schema' => ['description' => 'This parameter is used only for internal maintenance. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'SDK', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t5D622714-AEDD-4609-9167-F5DDD3D1****\\r\\n","errorExample":""}]', 'title' => 'ModifyAccountPassword', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-07-11T12:25:18.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAccountPassword'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyAccountPassword', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'ModifyActiveOperationMaintainConfig' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '194537', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'CycleType', 'in' => 'query', 'schema' => ['description' => 'The cycle type of the maintenance window. Valid values:'."\n" ."\n" .'- `Month`'."\n" ."\n" .'- `Week`', 'type' => 'string', 'required' => false, 'example' => 'Week', 'title' => ''], ], [ 'name' => 'CycleTime', 'in' => 'query', 'schema' => ['description' => 'The days of the cycle.'."\n" ."\n" .'- If `CycleType` is `Month`, specify the days of the month (1 to 28). Separate multiple days with a comma (,).'."\n" ."\n" .'- If `CycleType` is `Week`, specify the days of the week (1 to 7). Separate multiple days with a comma (,).', 'type' => 'string', 'required' => false, 'example' => '1,2,3,4,5', 'title' => ''], ], [ 'name' => 'MaintainStartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the maintenance window, specified in *HH:mm:ss*Z format (UTC time).', 'type' => 'string', 'required' => false, 'example' => '16:00:00Z', 'title' => ''], ], [ 'name' => 'MaintainEndTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the maintenance window, specified in *HH:mm:ss*Z format (UTC time).', 'type' => 'string', 'required' => false, 'example' => '20:00:00Z', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the configuration is enabled. Valid values:'."\n" ."\n" .'- 1: enabled'."\n" ."\n" .'- 2: disabled', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enum' => ['1', '2'], 'example' => '2', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Modify O&M Job Configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActiveOperationMaintainConfig'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyActiveOperationMaintainConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"561AFBF1-BE20-44DB-9BD1-6988B53E****\\"\\n}","type":"json"}]', 'summary' => 'ModifyActiveOperationMaintainConf', ], 'ModifyActiveOperationTask' => [ 'summary' => 'Changes the scheduled switchover time of an O\\&M task.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56467', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'Ids', 'in' => 'query', 'schema' => ['description' => 'The ID of the O\\&M task. Separate multiple IDs with commas (,).'."\n" ."\n" .'> You can call the [DescribeActiveOperationTask](~~473865~~) operation to query the ID of an O\\&M task.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11111,22222', 'title' => ''], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => ['description' => 'The scheduled switchover time to be specified. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> The time cannot be later than the latest operation time. You can call the [DescribeActiveOperationTask](~~473865~~) operation to obtain the latest operation time, which is the value of the **Deadline** parameter in the response.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-10-17T18:50:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Ids' => ['description' => 'The ID of the O\\&M task. IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => '11111,22222', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Missing input parameter'], ['errorCode' => 'TaskModifyError', 'errorMessage' => 'Part of the tasks cannot be modified.', 'description' => ''], ['errorCode' => 'SwitchTimeAfterDeadline', 'errorMessage' => 'The switch time should be earlier than deadline.', 'description' => ''], ['errorCode' => 'StartTimeBeforeNow', 'errorMessage' => 'The start time should not be earlier than the current time.', 'description' => ''], ], 403 => [ ['errorCode' => 'IncorrectTaskStatus', 'errorMessage' => 'Certain task\'s status does not support this operation.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Ids\\": \\"11111,22222\\",\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5D622714-AEDD-4609-9167-F5DDD3D1****\\n 11111,22222\\n","errorExample":""}]', 'title' => 'ModifyActiveOperationTask', 'description' => 'You can receive notifications for Tair (Redis OSS-compatible) events such as instance migration and version upgrade by text message, phone call, email, internal message, or by using the console. You can also change the scheduled switchover time of a task by using the console. For more information, see [Query or manage pending events](~~187022~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyActiveOperationTask'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyActiveOperationTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyActiveOperationTasks' => [ 'summary' => 'Modifies the switching time of scheduled O\\\\\\&M events for an instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56468', 'abilityTreeNodes' => ['FEATUREkvstoreJ3DM1I'], ], 'parameters' => [ [ 'name' => 'Ids', 'in' => 'query', 'schema' => ['description' => 'The IDs of the O\\&M events. Separate multiple event IDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1111721,1111718', 'title' => ''], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => ['description' => 'The scheduled switching time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" ."\n" .'> The time that is specified by the SwitchTime parameter cannot be later than the time that is specified by the Deadline parameter. You can call the DescribeActiveOperationTasks operation to query the latest switching time that is returned for the Deadline parameter.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-10-17T18:50:00Z'."\n", 'title' => ''], ], [ 'name' => 'ImmediateStart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to immediately start scheduling. Valid values:'."\n" ."\n" .'* 0 (default): Scheduling is not started immediately.'."\n" .'* 1: Scheduling is started immediately.'."\n" ."\n" .'> If you set this parameter to 0, the SwitchTime parameter takes effect. If you set this parameter to 1, the SwitchTime parameter does not take effect. In this case, the start time of the event is set to the current time, and the system determines the switching time based on the start time. Scheduling is started immediately, which is a prerequisite for the switchover. Then, the switchover is performed. You can call the DescribeActiveOperationTasks operation to query the preparation time that is returned for the PrepareInterval parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Ids' => ['description' => 'The IDs of the O\\&M events. Separate multiple event IDs with commas (,).'."\n", 'type' => 'string', 'example' => '11111,22222', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E278D833-BB4B-50BF-8646-7BC1BAB2373B', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"11111,22222\\",\\n \\"RequestId\\": \\"E278D833-BB4B-50BF-8646-7BC1BAB2373B\\"\\n}","type":"json"}]', 'title' => 'ModifyActiveOperationTasks', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyAuditLogConfig' => [ 'summary' => 'Enables the audit log feature or modifies the audit log settings for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56469', 'abilityTreeNodes' => ['FEATUREkvstoreE2TR4H'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Retention', 'in' => 'query', 'schema' => ['description' => 'The retention period of audit logs. Valid values: **1** to **365**. Unit: days.'."\n" ."\n" .'> '."\n" ."\n" .'* This parameter is required only when the **DbAudit** parameter is set to **true**.'."\n" ."\n" .'* The value of this parameter takes effect for all instances in the current region.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '365', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ 'name' => 'DbAudit', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable the audit log feature. Default value: true. Valid values:'."\n" ."\n" .'* **true**: enables the audit log feature.'."\n" .'* **false**: disables the audit log feature.'."\n" ."\n" .'> If the instance uses the [cluster architecture](~~52228~~) or [read/write splitting architecture](~~62870~~), the audit log feature is enabled or disabled for both the data nodes and proxy nodes. You cannot separately enable the audit log feature for the data nodes or proxy nodes.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidRetention', 'errorMessage' => 'The Retention is invalid.', 'description' => ''], ['errorCode' => 'ResourceConfigError', 'errorMessage' => 'The request processing has failed due to resource config error.', 'description' => ''], ], 403 => [ ['errorCode' => 'TaskHasExist', 'errorMessage' => 'The task already exists.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B****\\"\\n}","type":"json"}]', 'title' => 'ModifyAuditLogConfig', 'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](~~54532~~) of the audit log feature.'."\n" ."\n" .'Before you call this operation, make sure that the Tair (Redis OSS-compatible) instance meets the following requirements:'."\n" ."\n" .'* The instance is a Tair (Redis OSS-compatible) Community Edition instance or Tair [DRAM-based instance](~~126164~~).'."\n" .'* The engine version of the instance is Redis 4.0 or later, and the latest minor version is used. You can call the [DescribeEngineVersion](~~473781~~) operation to check whether the instance uses the latest major version and minor version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAuditLogConfig'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyAuditLogConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:DbAudit', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], ], 'ModifyBackupExpireTime' => [ 'summary' => 'Extends the expiration time of manual backup data.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '269550', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup file. You can call the [DescribeBackups](~~473823~~) operation to query the IDs of backup files.'."\n", 'type' => 'string', 'required' => false, 'example' => '521****66', 'title' => ''], ], [ 'name' => 'ExpectExpireTime', 'in' => 'query', 'schema' => ['description' => 'The point in time to which you want to extend the expiration time. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The time cannot be earlier than the current expiration time.'."\n", 'type' => 'string', 'required' => true, 'example' => '2025-07-06T07:25:57Z', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B560AAD5-5027-51AD-A0D4-FA4DB1A76F40'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B560AAD5-5027-51AD-A0D4-FA4DB1A76F40\\"\\n}","type":"json"}]', 'title' => 'ModifyBackupExpireTime', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyBackupExpireTime'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyBackupExpireTime', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyBackupPolicy' => [ 'summary' => 'Modifies the automatic backup policy of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56470', 'abilityTreeNodes' => ['FEATUREkvstoreQ7TNCG', 'FEATUREkvstore6TUUNS', 'FEATUREkvstoreHXG88M', 'FEATUREkvstoreGDR25F'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'PreferredBackupTime', 'in' => 'query', 'schema' => ['description' => 'The time range to back up data. Specify the time in the *HH:mm*Z-*HH:mm*Z format. The time is displayed in UTC.'."\n" ."\n" .'> The beginning and end of the time range must be on the hour. The duration must be an hour.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '07:00Z-08:00Z', 'title' => ''], ], [ 'name' => 'PreferredBackupPeriod', 'in' => 'query', 'schema' => ['description' => 'The days of the week to back up data. Valid values:'."\n" ."\n" .'* **Monday**'."\n" .'* **Tuesday**'."\n" .'* **Wednesday**'."\n" .'* **Thursday**'."\n" .'* **Friday**'."\n" .'* **Saturday**'."\n" .'* **Sunday**'."\n" ."\n" .'> Separate multiple options with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Tuesday', 'title' => ''], ], [ 'name' => 'EnableBackupLog', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable the data flashback feature for the instance. Valid values:'."\n" ."\n" .'* **1**: enables the data flashback feature. You must also enable append-only file (AOF) persistence by setting `appendonly` to `yes` in the parameter settings of the instance. Then, you can use the data flashback feature.'."\n" .'* **0** (default): disables the data flashback feature.'."\n" ."\n" .'> This parameter is available only for Tair (Enterprise Edition) DRAM-based and persistent memory-optimized instances. For more information, see [Data flashback](~~148479~~).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '0', 'title' => ''], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', 'schema' => ['description' => 'The number of days for which you want to retain data backup files. Valid values: 7 to 730. Default value: 7.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '730', 'example' => '7', 'default' => '7', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B****\\"\\n}","errorExample":"{\\n\\"RequestId\\" : \\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76”\\n}"},{"type":"xml","example":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B****\\n","errorExample":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\n"}]', 'title' => 'ModifyBackupPolicy', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-05-16T15:55:55.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-30T11:36:15.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-03T12:59:16.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyBackupPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:EnableBackupLog', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'ModifyDBInstanceAutoUpgrade' => [ 'summary' => 'Modifies the settings related to the automatic minor version update for an instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. You can call the DescribeDBInstances operation to obtain the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Value', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic minor version update. Valid values:'."\n" ."\n" .'* **1**: enables automatic minor version update.'."\n" .'* **0**: disables automatic minor version update.'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => ['0', '1'], 'example' => '0', 'enum' => ['0', '1'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'ID of the request.', 'type' => 'string', 'example' => '2FF6158E-3394-4A90-B634-79C49184****'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FF6158E-3394-4A90-B634-79C49184****\\"\\n}","type":"json"}]', 'title' => 'ModifyDBInstanceAutoUpgrade', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceAutoUpgrade'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyDBInstanceAutoUpgrade', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyDBInstanceConnectionString' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56472', 'abilityTreeNodes' => ['FEATUREkvstoreS0D17V'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'NewConnectionString', 'in' => 'query', 'schema' => ['description' => 'The prefix of the new endpoint. Specify the endpoint in the `.redis.rds.aliyuncs.com` format. The prefix must be 8 to 40 characters in length and can contain lowercase letters and digits. It must start with a lowercase letter.'."\n" ."\n" .'> You must specify one of the **NewConnectionString** and **Port** parameters.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'standardredis123', 'title' => ''], ], [ 'name' => 'CurrentConnectionString', 'in' => 'query', 'schema' => ['description' => 'The current endpoint of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', 'title' => ''], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => ['description' => 'The port number of the instance. Valid values: **1024** to **65535**.'."\n" ."\n" .'> You must specify one of the **NewConnectionString** and **Port** parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '6379', 'maxLength' => 5, 'minLength' => 1, 'pattern' => '^\\d+$', 'title' => ''], ], [ 'name' => 'IPType', 'in' => 'query', 'schema' => ['description' => 'The network type of the endpoint. Valid values:'."\n" ."\n" .'* **Private**: internal network'."\n" .'* **Public**: Internet'."\n", 'type' => 'string', 'required' => false, 'example' => 'Public', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1790D68A-465C-44E3-BC24-9732652961F9', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'NewConnectionStringNotSupport', 'errorMessage' => 'Specified newConnectionString is not supported.', 'description' => ''], ['errorCode' => 'InvalidIPType.Format', 'errorMessage' => 'Specified parameter IPType is not supported.', 'description' => ''], ['errorCode' => 'InvalidConnectionStringOrPort.Duplicate', 'errorMessage' => 'Specified connection string or port want to be modified is the same with current net type.', 'description' => 'The connection string or port already exists.'], ['errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', 'description' => 'The connection string is invalid. Use a different one.'], ], ], 'title' => 'ModifyDBInstanceConnectionString', 'summary' => 'Changes the endpoint or port number of a Tair (Redis OSS-compatible) instance.', 'description' => 'You can also modify the endpoint or port number of an instance in the Tair (Redis OSS-compatible) console. For more information, see [Change the endpoint or port number of an instance](~~85683~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConnectionString'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyDBInstanceConnectionString', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1790D68A-465C-44E3-BC24-9732652961F9\\"\\n}","errorExample":"{\\n\\t\\"code\\": \\"200\\",\\n\\t\\"data\\": {\\n\\t\\t\\"RequestId\\": \\"A7CCD05D-74FE-44DE-A4F0-C3EE58A252BE\\"\\n\\t},\\n\\t\\"successResponse\\": true\\n}"},{"type":"xml","example":"\\n\\t1790D68A-465C-44E3-BC24-9732652961F9\\n","errorExample":"\\n\\t200\\n\\t\\n\\t\\tA7CCD05D-74FE-44DE-A4F0-C3EE58A252BE\\n\\t\\n\\ttrue\\n"}]', ], 'ModifyDBInstanceMonitor' => [ 'summary' => 'Modifies the monitoring granularity for a Tair instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56473', 'abilityTreeNodes' => ['FEATUREkvstoreW1V0SW'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated. The monitoring granularity is fixed at 60 seconds.', 'enumValueTitles' => [60 => ''], 'type' => 'string', 'required' => true, 'enum' => ['5', '60'], 'example' => '60', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BE6E619-A657-42E3-AD2D-18F8428A****\\"\\n}","type":"json"}]', 'title' => 'ModifyDBInstanceMonitor', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBInstanceMonitor'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyDBInstanceMonitor', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyEventInfo' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232944', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => ['description' => 'The ID of the event. You can specify up to 20 event IDs. Separate multiple IDs with commas.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '5422964'."\n"], ], [ 'name' => 'EventAction', 'in' => 'query', 'schema' => ['description' => 'The action to perform on the event. Valid values:'."\n" ."\n" .'- **archive**: Archives the event.'."\n" ."\n" .'- **undo**: Cancels processing for the event.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'archive'], ], [ 'name' => 'ActionParams', 'in' => 'query', 'schema' => ['description' => 'The parameters for the action, in JSON format. For example: `{"recoverMode": "xxx", "recoverTime": "xxx"}`.'."\n" ."\n" .'- **recoverMode**: The recovery mode. Valid values:'."\n" ."\n" .' - **timePoint**: Executes the task at the time specified by `recoverTime`.'."\n" ."\n" .' - **immediate**: Executes the task immediately.'."\n" ."\n" .' - **maintainTime**: Executes the task during the maintenance window.'."\n" ."\n" .'- **recoverTime**: The time to execute the task. This parameter is required when **recoverMode** is set to **timePoint**. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"recoverTime":"2023-04-17T14:02:35Z","recoverMode":"timePoint"}'."\n"], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6C9E114C-217C-4118-83C0-B4070222****'], 'ErrorEventId' => ['description' => 'The IDs of the events that failed to be processed.', 'type' => 'string', 'example' => '12343', 'title' => ''], 'SuccessCount' => ['description' => 'The number of events that were successfully processed.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'mst.errorcode.success.errormessage', 'title' => ''], 'SuccessEventId' => ['description' => 'The IDs of the events that were successfully processed.', 'type' => 'string', 'example' => '234221', 'title' => ''], ], 'example' => '', ], ], ], 'title' => 'Modify event information ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyEventInfo'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyEventInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C9E114C-217C-4118-83C0-B4070222****\\",\\n \\"ErrorEventId\\": \\"12343\\",\\n \\"SuccessCount\\": 2,\\n \\"ErrorCode\\": \\"mst.errorcode.success.errormessage\\",\\n \\"SuccessEventId\\": \\"234221\\"\\n}","type":"json"}]', 'summary' => 'Modify event information in Event Center ', ], 'ModifyGlobalSecurityIPGroup' => [ 'summary' => 'Modifies a global IP whitelist template.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'GlobalIgName', 'in' => 'query', 'schema' => ['description' => 'The name of the IP whitelist template. The name must meet the following requirements:'."\n" ."\n" .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" .'* The name must start with a letter and end with a letter or a digit.'."\n" .'* The name must be 2 to 120 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_123', 'maxLength' => 120, 'minLength' => 2, 'title' => ''], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the IP whitelist template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], ], [ 'name' => 'GIpList', 'in' => 'query', 'schema' => ['description' => 'The IP addresses in the IP whitelist template.'."\n", 'type' => 'string', 'required' => true, 'example' => '192.168.0.1,10.10.10.10,172.16.0.1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '686BB8A6-BBA5-47E5-8A75-D2ADE433****'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Missing input parameter'], ['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => 'The number of IP addresses in the list exceeds the limit'], ['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'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"686BB8A6-BBA5-47E5-8A75-D2ADE433****\\"\\n}","type":"json"}]', 'title' => 'ModifyGlobalSecurityIPGroup', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroup'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyGlobalSecurityIPGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyGlobalSecurityIPGroupName' => [ 'summary' => 'Modifies the name of a global IP whitelist template.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'GlobalIgName', 'in' => 'query', 'schema' => ['description' => 'The name of the global IP whitelist template. The name must meet the following requirements:'."\n" ."\n" .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" .'* The name must start with a letter and end with a letter or a digit.'."\n" .'* The name must be 2 to 120 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_123', 'maxLength' => 120, 'minLength' => 2, 'title' => ''], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the IP whitelist template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'g-kd2iop4aur9qwxnvh***', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2B17D708-1D6D-49F3-B6D7-478371DD****'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Missing input parameter'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B17D708-1D6D-49F3-B6D7-478371DD****\\"\\n}","type":"json"}]', 'title' => 'ModifyGlobalSecurityIPGroupName', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroupName'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyGlobalSecurityIPGroupName', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyGlobalSecurityIPGroupRelation' => [ 'summary' => 'Adds a specified instance to a specified IP whitelist template.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-t4n885e834f6****', 'title' => ''], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The ID of the IP whitelist template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'g-zsldxfiwjmti0kcm****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1E83311F-0EE4-4922-A3BF-730B312B****'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', 'description' => 'Missing input parameter'], ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'The specified parameters are invalid.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E83311F-0EE4-4922-A3BF-730B312B****\\"\\n}","type":"json"}]', 'title' => 'ModifyGlobalSecurityIPGroupRelation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroupRelation'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyGlobalSecurityIPGroupRelation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyInstanceAttribute' => [ 'summary' => 'Modifies the specific information of a Tair (Redis OSS-compatible) instance, such as the password and the name.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56477', 'abilityTreeNodes' => ['FEATUREkvstore4XSUU7', 'FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreZ21KYW', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The new name of the instance. The name must be 2 to 80 characters in length. The name must start with a letter and cannot contain spaces and the following special characters: `@ / : = " < > { [ ] }`'."\n", 'type' => 'string', 'required' => false, 'example' => 'newinstancename', 'title' => ''], ], [ 'name' => 'NewPassword', 'in' => 'query', 'schema' => ['description' => 'The new password for the default account. The default account is named after the instance ID. Example: r-bp10noxlhcoim2\\*\\*\\*\\*.'."\n" ."\n" .'> The password must be 8 to 32 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. These special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n", 'type' => 'string', 'required' => false, 'example' => 'uW8+nsrp', 'title' => ''], ], [ 'name' => 'InstanceReleaseProtection', 'in' => 'query', 'schema' => ['description' => '[Specifies whether to enable release protection for the instance.](~~165005~~) Valid values:'."\n" ."\n" .'* **true**: enables release protection.'."\n" .'* **false**: disables release protection.'."\n" ."\n" .'> This parameter is available only for pay-as-you-go instances.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => 'InstanceName or NewPassword at least one is mandatory for this action.', 'description' => ''], ['errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter InstanceName is not valid.', 'description' => ''], ['errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The Specified parameter NewPassword is not valid.', 'description' => ''], ['errorCode' => 'TaskExists', 'errorMessage' => 'Specified task have existed.', 'description' => ''], ], ], 'title' => 'ModifyInstanceAttribute', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-03-25T11:17:43.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-02T02:42:53.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceAttribute'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"EFC9161F-15E3-4A6E-8A99-C09916D1F464\\"\\n}"},{"type":"xml","example":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\n","errorExample":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\n"}]', 'description' => 'You can also modify the information of an instance in the Tair (Redis OSS-compatible) console. For more information, see [Change or reset the password](~~43874~~).', ], 'ModifyInstanceAutoRenewalAttribute' => [ 'summary' => 'Enables or disables auto-renewal for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56478', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. Separate multiple instance IDs with commas (,).'."\n" ."\n" .'> You can specify up to 30 instance IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => ['description' => 'The auto-renewal period. Valid values: **1** to **12**. Unit: months. When the instance is about to expire, the instance is automatically renewed based on the number of months specified by this parameter.'."\n" ."\n" .'> This parameter is available and required only if the **AutoRenew** parameter is set to **true**.'."\n", 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n" ."\n" .'> The default value is **false**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', 'default' => 'False', 'title' => ''], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => ['description' => 'The service. Set the value to kvstore.'."\n", 'type' => 'string', 'required' => false, 'example' => 'kvstore', 'default' => 'kvstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '52D901ED-E0A5-42FB-B9DB-39C295C3****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52D901ED-E0A5-42FB-B9DB-39C295C3****\\"\\n}","type":"json"}]', 'title' => 'ModifyInstanceAutoRenewalAttribute', 'description' => '> Auto-renewal is triggered seven days before the expiration date of the instance.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-02-27T12:09:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-03-02T02:42:53.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceAutoRenewalAttribute'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceAutoRenewalAttribute', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyInstanceBandwidth' => [ 'summary' => 'Sets the intended bandwidth value of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '233858', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'TargetIntranetBandwidth', 'in' => 'query', 'schema' => ['description' => 'The total expected bandwidth of the instance.'."\n" ."\n" .'> If the instance is a cluster instance, the TargetIntranetBandwidth must be divisible by the number of shards in the instance. This operation is not supported for read/write splitting instances.', 'type' => 'string', 'required' => true, 'example' => '260', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '236934422960904', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"236934422960904\\",\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","type":"json"}]', 'title' => 'ModifyInstanceBandwidth', 'description' => '* Before you call this operation, make sure that you understand the billing methods and pricing of instance bandwidth. Tair (Redis OSS-compatible) charges fees per hour based on the amount and usage duration of the extra bandwidth that you purchase. The fees vary based on the region that you select. For more information, see [Billable items](~~54532~~).'."\n" .'* The bandwidth of an instance or a shard can be increased by up to six times the default bandwidth of the instance, but the increase in bandwidth cannot exceed 192 Mbit/s. For example, if the default bandwidth of a Tair DRAM-based master-replica instance equipped with 2 GB of memory is 96 Mbit/s, you can increase the bandwidth of the instance by up to 192 Mbit/s. As a result, the maximum bandwidth of the instance is 288 Mbit/s. If the default bandwidth of a Redis Open-Source Edition master-replica instance equipped with 256 MB of memory is 10 Mbit/s, you can increase the bandwidth of the instance by up to 60 Mbit/s. As a result, the maximum bandwidth of the instance is 70 Mbit/s.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceBandwidth'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceBandwidth', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyInstanceConfig' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56480', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => ['description' => 'The instance parameters to modify, in JSON format. The new values overwrite the existing values. For example, if you want to set only the **maxmemory-policy** parameter to **noeviction**, pass in `{"maxmemory-policy":"noeviction"}`.'."\n" .'> For more information about each parameter, see [Metric description](~~259681~~).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"maxmemory-policy":"volatile-lru","zset-max-ziplist-entries":128,"zset-max-ziplist-value":64,"hash-max-ziplist-entries":512,"set-max-intset-entries":512}', 'title' => ''], ], [ 'name' => 'ParamReplMode', 'in' => 'query', 'schema' => ['description' => 'The synchronization pattern. Valid values:'."\n" .'* **async** (default): asynchronous'."\n" .'* **semisync**: semi-synchronous.', 'type' => 'string', 'required' => false, 'example' => 'async', 'title' => ''], ], [ 'name' => 'ParamSemisyncReplTimeout', 'in' => 'query', 'schema' => ['description' => 'The degradation threshold for semi-synchronous mode. This parameter is supported only in semi-synchronous mode. Unit: ms. Valid values: 10 to 60000. Default value: 500.'."\n" .'> * When the synchronization latency exceeds this threshold, the synchronous mode automatically transforms to asynchronous. When the latency is eliminated, the synchronous mode automatically transforms back to semi-synchronous.'."\n" .'> * This parameter is supported only by Tair Enterprise instances. This feature is in public preview.', 'type' => 'string', 'required' => false, 'example' => '500', 'title' => ''], ], [ 'name' => 'ParamNoLooseSentinelEnabled', 'in' => 'query', 'schema' => ['description' => 'The Sentinel compatibility mode. This parameter applies to non-cluster instances. Valid values:'."\n" .'* **no** (default): disabled.'."\n" .'* **yes**: enabled.'."\n" .'> For more information, see [Sentinel compatibility mode](~~178911~~).', 'type' => 'string', 'required' => false, 'example' => 'yes', 'title' => ''], ], [ 'name' => 'ParamSentinelCompatEnable', 'in' => 'query', 'schema' => ['description' => 'The Sentinel compatibility mode. This parameter applies to instances that use the proxy connection mode in cluster architecture or instances that use the read/write splitting architecture. Valid values:'."\n" .'* **0** (default): disabled.'."\n" .'* **1**: enabled.'."\n" .'> For more information, see [Sentinel compatibility mode](~~178911~~).', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ParamNoLooseSentinelPasswordFreeAccess', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to allow password-free execution of Sentinel-related commands when Sentinel mode is enabled. Valid values:'."\n" .'* **no** (default): disabled.'."\n" .'* **yes**: enabled. After this parameter is enabled, you can run Sentinel commands without a password on any connection and use the SENTINEL command to listen on the +switch-master channel.', 'type' => 'string', 'required' => false, 'example' => '****', 'title' => ''], ], [ 'name' => 'ParamNoLooseSentinelPasswordFreeCommands', 'in' => 'query', 'schema' => ['description' => 'After Sentinel mode and the ParamNoLooseSentinelPasswordFreeAccess parameter are enabled, use this parameter to add additional password-free commands (empty by default).'."\n" .'> * After this parameter is set, the specified commands can be run without a password on any connection. Proceed with caution.'."\n" .'> * Commands must be in lowercase letters. Separate multiple commands with commas (,).', 'type' => 'string', 'required' => false, 'example' => '****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The parameter is invalid.'], ['errorCode' => 'ParamNotSupportedForCurrentVersion', 'errorMessage' => 'Parameter is not supported for current version.', 'description' => ''], ], 403 => [ ['errorCode' => 'InstanceType.NotSupport', 'errorMessage' => 'Current instance type does not support this operation.', 'description' => ''], ['errorCode' => 'NetworkType.NotSupport', 'errorMessage' => 'Current network type does not support this operation.', 'description' => ''], ], ], 'title' => 'Modify instance parameter settings', 'summary' => 'Modifies the parameter settings of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance.', 'changeSet' => [ ['createdAt' => '2024-12-11T07:48:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-03T02:42:02.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-11-05T14:48:25.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceConfig'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:InstanceAofConfig', 'validationType' => 'conditional'], ['conditionKey' => 'kvstore:TLSVersion', 'validationType' => 'conditional'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B****\\"\\n}","type":"json"}]', ], 'ModifyInstanceMaintainTime' => [ 'summary' => 'Modifies the maintenance window of a Tair (Redis OSS-compatible) instance. Alibaba Cloud maintains Tair (Redis OSS-compatible) instances during the specified maintenance window.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56481', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreZ21KYW', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'MaintainStartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the maintenance window. The time is in the *HH:mm*Z format. The time is displayed in UTC. For example, if you want the maintenance to start at 1:00 (UTC+8), set this parameter to `17:00Z`. After you call the API operation, you can view the actual time in the Tair (Redis OSS-compatible) console. For more information, see [Set a maintenance window](~~55252~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '03:00Z', 'title' => ''], ], [ 'name' => 'MaintainEndTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the maintenance window. The time is in the *HH:mm*Z format. The time is displayed in UTC. For example, if you want the maintenance window to end at 2:00 (UTC+8), set this parameter to `18:00Z`.'."\n" ."\n" .'> The interval between the start time and the end time cannot be less than 1 hour.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '04:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', 'description' => 'The incoming end time does not meet the specification.'], ], ], 'title' => 'ModifyInstanceMaintainTime', 'description' => 'You can also modify the maintenance window of an instance in the Tair (Redis OSS-compatible) console. For more information, see [Set a maintenance window](~~55252~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-03-25T11:17:42.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-02T02:42:53.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceMaintainTime'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceMaintainTime', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\"\\n}","errorExample":"{\\n\\t\\"RequestId\\": \\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\"\\n}"},{"type":"xml","example":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\n","errorExample":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\n"}]', ], 'ModifyInstanceMajorVersion' => [ 'summary' => 'Upgrades the major version of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56482', 'abilityTreeNodes' => ['FEATUREkvstore4XSUU7', 'FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreZ21KYW', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'MajorVersion', 'in' => 'query', 'schema' => ['description' => 'The major version to which you want to upgrade the instance. Valid values: **4.0** and **5.0**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5.0', 'title' => ''], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want to upgrade the major version. Valid values:'."\n" ."\n" .'* **Immediately** (default): immediately upgrades the major version.'."\n" .'* **MaintainTime**: upgrades the major version within the maintenance window.'."\n" ."\n" .'> You can call the [ModifyInstanceMaintainTime](~~473775~~) operation to modify the maintenance window of an instance.', 'type' => 'string', 'required' => false, 'example' => 'Immediately', 'default' => '0', 'enum' => ['0', '1', 'Immediately', 'MaintainTime'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AA587FB2-2593-4DFE-BE13-2494C2DF****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoQuota', 'errorMessage' => 'Request zone has no quota to sell.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AA587FB2-2593-4DFE-BE13-2494C2DF****\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"AA587FB2-2593-4DFE-BE13-2494C2DF0CBF\\"\\n}"},{"type":"xml","example":" \\n AA587FB2-2593-4DFE-BE13-2494C2DF****\\n","errorExample":" \\n AA587FB2-2593-4DFE-BE13-2494C2DF0CBF\\n"}]', 'title' => 'ModifyInstanceMajorVersion', 'description' => 'For more information about the precautions and impacts of the upgrade, see [Upgrade the major version](~~101764~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceMajorVersion'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceMajorVersion', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'ModifyInstanceMinorVersion' => [ 'summary' => 'Updates the minor version of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56483', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreZ21KYW', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Minorversion', 'in' => 'query', 'schema' => ['description' => 'The minor version to which you want to update. Default value: **latest_version**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'latest_version', 'default' => 'latest_version', 'title' => ''], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want to update the minor version. Valid values:'."\n" ."\n" .'* **Immediately** (default): immediately updates the minor version.'."\n" .'* **MaintainTime**: updates the minor version during the maintenance window.'."\n" ."\n" .'> You can call the [ModifyInstanceMaintainTime](~~473775~~) operation to modify the maintenance window of an instance.', 'type' => 'string', 'required' => false, 'example' => 'Immediately', 'default' => '0', 'enum' => ['0', '1', 'Immediately', 'MaintainTime'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '28761557-0B33-41DF-AEEB-322DFF96****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoQuota', 'errorMessage' => 'Request zone has no quota to sell.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"28761557-0B33-41DF-AEEB-322DFF96****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 28761557-0B33-41DF-AEEB-322DFF96****\\r\\n","errorExample":""}]', 'title' => 'ModifyInstanceMinorVersion', 'description' => 'The procedure to update the minor version of an instance varies based on types of Tair (Redis OSS-compatible) instances. For more information, see [Upgrade the minor version](~~56450~~).'."\n" ."\n" .'> '."\n" ."\n" .'* Before you call this operation, you can call the [DescribeEngineVersion](~~473781~~) operation to query the minor version of the current instance.'."\n" .'* When you switch your workloads over from the original instance to a new instance or from the master node to the replica node in the original instance, you may experience disconnections that last a few seconds. The original instance stays in the read-only state within 60 seconds until all data is synchronized. We recommend that you upgrade the original instance during off-peak hours and make sure that your application is configured to automatically reconnect to the original instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceMinorVersion'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceMinorVersion', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'ModifyInstanceNetExpireTime' => [ 'summary' => 'Extends the retention period of the classic network endpoint of a Tair (Redis OSS-compatible) instance. You can call this operation after you change the network type of the Tair (Redis OSS-compatible) instance from classic network to Virtual Private Cloud (VPC) with the classic network endpoint retained.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56484', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => ['description' => 'The endpoint of the classic network.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', 'title' => ''], ], [ 'name' => 'ClassicExpiredDays', 'in' => 'query', 'schema' => ['description' => 'The extension period to retain the classic network endpoint of the instance. Unit: days. Valid values: **14**, **30**, **60**, and **120**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '14', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9C4AF387-1EA3-4C84-8013-3F6B973EDDF5', 'title' => ''], 'NetInfoItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'NetInfoItem' => [ 'description' => 'Details about the extension period for which the classic network endpoint of the instance is retained.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The classic network information about the instance.'."\n", 'type' => 'object', 'properties' => [ 'Port' => ['description' => 'The port number that is used to connect to the instance.'."\n", 'type' => 'string', 'example' => '6379', 'title' => ''], 'DBInstanceNetType' => ['description' => 'The network type of the instance. The returned value is **Classic**.'."\n", 'type' => 'string', 'example' => 'Classic', 'title' => ''], 'ConnectionString' => ['description' => 'The endpoint of the classic network.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', 'title' => ''], 'ExpiredTime' => ['description' => 'The expiration time of the classic network endpoint.'."\n", 'type' => 'string', 'example' => '2019-08-01T09:29:18Z', 'title' => ''], 'IPAddress' => ['description' => 'The IP address of the instance in the classic network.'."\n", 'type' => 'string', 'example' => '100.118.142.***', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ClassicExpiredDaysError', 'errorMessage' => 'The ClassicExpiredDays can not set to 0.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"RequestId\\": \\"9C4AF387-1EA3-4C84-8013-3F6B973EDDF5\\",\\n \\"NetInfoItems\\": {\\n \\"NetInfoItem\\": [\\n {\\n \\"Port\\": \\"6379\\",\\n \\"DBInstanceNetType\\": \\"Classic\\",\\n \\"ConnectionString\\": \\"r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com\\",\\n \\"ExpiredTime\\": \\"2019-08-01T09:29:18Z\\",\\n \\"IPAddress\\": \\"100.118.142.***\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n\\t\\"InstanceId\\": \\"r-xxxxxxxxxxxxxxx\\",\\n\\t\\"RequestId\\": \\"9C4AF387-1EA3-4C84-8013-3F6B973EDDF5\\",\\n\\t\\"NetInfoItems\\": {\\n\\t\\t\\"NetInfoItem\\": [{\\n\\t\\t\\t\\t\\"ConnectionString\\": \\"r-xxxxxxxxxxxxxxx.redis.rds.aliyuncs.com\\",\\n\\t\\t\\t\\t\\"Port\\": \\"6379\\",\\n\\t\\t\\t\\t\\"DBInstanceNetType\\": \\"Classic\\",\\n\\t\\t\\t\\t\\"IPAddress\\": \\"xxx.xxx.xxx.xxx\\",\\n\\t\\t\\t\\t\\"ExpiredTime\\": \\"2018-11-18T08:04:46Z\\"\\n\\t\\t\\t}\\n\\t\\t]\\n\\t}\\n}"},{"type":"xml","example":"\\n r-bp1zxszhcgatnx****\\n 9C4AF387-1EA3-4C84-8013-3F6B973EDDF5\\n \\n \\n r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com\\n 6379\\n Classic\\n 100.118.142.***\\n 2019-08-01T09:29:18Z\\n \\n \\n","errorExample":"\\n r-xxxxxxxxxxxxxxx\\n 9C4AF387-1EA3-4C84-8013-3F6B973EDDF5\\n \\n \\n r-xxxxxxxxxxxxxxx.redis.rds.aliyuncs.com\\n 6379\\n Classic\\n xxx.xxx.xxx.xxx\\n 2018-11-18T08:04:46Z\\n \\n \\n"}]', 'title' => 'ModifyInstanceNetExpireTime', 'description' => 'You can also perform this operation in the Tair (Redis OSS-compatible) console. For more information, see [Change the expiration time for the endpoint of the classic network](~~60062~~).'."\n" ."\n" .'> For more information about how to switch the network type of a Tair (Redis OSS-compatible) instance from classic network to VPC, see [SwitchNetwork](~~473797~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceNetExpireTime'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceNetExpireTime', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'ModifyInstanceParameter' => [ 'summary' => 'Applies a parameter template to specific instances. This indicates that the parameter values in the template take effect on the instances. After you modify a parameter template, you must reapply it to specific instances for the new parameter values to take effect on the instances.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '180441', 'abilityTreeNodes' => ['FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The region ID.'."\n", 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => ['description' => 'The parameter template ID.'."\n" ."\n" .'> You can view the list of parameter templates in the target region, including the parameter template ID, through the DescribeParameterGroups interface.', 'type' => 'string', 'required' => false, 'example' => 'g-idhwofwofewhf****', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => ['description' => 'The information about parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"hz": "50"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****'], 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '578678678', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"561AFBF1-BE20-44DB-9BD1-6988B53E****\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"TaskId\\": 578678678\\n}","type":"json"}]', 'title' => 'ModifyInstanceParameter', 'changeSet' => [ ['createdAt' => '2024-08-05T08:39:27.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceParameter'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceParameter', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyInstanceSSL' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56487', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'SSLEnabled', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable TLS (SSL) encryption. Valid values:'."\n" ."\n" .'- **Disable**: disables SSL encryption.'."\n" ."\n" .'- **Enable**: enables SSL encryption.'."\n" ."\n" .'- **Update**: updates the SSL certificate.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'enum' => ['Disable', 'Enable', 'Update'], 'example' => 'Enable', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AD7E16AA-6B23-43BF-979C-07D957FB****', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => '32184****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', 'description' => 'The parameter is invalid.'], ], 403 => [ ['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' => 'The operation cannot be performed until the instance is in the running state.'], ['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' => 'ModifyInstanceSSL', 'summary' => 'Enables Transport Layer Security (TLS) for a Tair (Redis OSS-compatible) instance.', 'description' => 'You can also configure SSL encryption in the console. For more information, see [Configure SSL encryption](~~84898~~).'."\n" ."\n" .'> To specify the earliest supported SSL version, you can call the [ModifyInstanceConfig](~~473844~~) operation to modify the required parameter.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceSSL'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceSSL', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:SSLEnabled', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD7E16AA-6B23-43BF-979C-07D957FB****\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"TaskId\\": \\"32184****\\"\\n}","type":"json"}]', ], 'ModifyInstanceSpec' => [ 'summary' => 'Changes the configurations of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56485', 'abilityTreeNodes' => ['FEATUREkvstore6PLKNO', 'FEATUREkvstore6VEW31', 'FEATUREkvstore1Q5K7Z'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. You can call the [DescribeInstances](~~473778~~) operation to query the instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => ['description' => 'The new instance type. You can call the [DescribeAvailableResource](~~473765~~) operation to query the instance types available for configuration change within the zone to which the instance belongs.'."\n" ."\n" .'> For more information about the instance types, see [Overview](~~26350~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'redis.master.small.default', 'title' => ''], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => ['description' => 'The ID of the promotional event or the business information.'."\n", 'type' => 'string', 'required' => false, 'example' => '000000001', 'title' => ''], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => ['description' => 'The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'default' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], ], [ 'name' => 'ForceUpgrade', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to forcibly change the configurations. Valid values:'."\n" ."\n" .'* **false**: The system does not forcefully change the configurations.'."\n" .'* **true** (default): The system forcefully changes the configurations.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', 'title' => ''], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => ['description' => 'The time when you want the configurations to be changed. Valid values:'."\n" ."\n" .'* **Immediately** (default): immediately changes the configurations.'."\n" .'* **MaintainTime**: changes the configurations within the maintenance window. You can call the [ModifyInstanceMaintainTime](~~473775~~) operation to change the maintenance window.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Immediately', 'default' => 'Immediately', 'title' => ''], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" ."\n" .'* **true** (default): enables automatic payment.'."\n" .'* **false**: disables automatic payment. If you set this parameter to **false**, the instance must be manually renewed before it expires. For more information, see [Renew an instance](~~26352~~).'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'default' => 'true', 'title' => ''], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => [ 'description' => 'The change type. This parameter is required when you change the configurations of a subscription instance. Valid values:'."\n" ."\n" .'* **UPGRADE** (default): upgrades the configurations of the subscription instance.'."\n" .'* **DOWNGRADE**: downgrades the configurations of the subscription instance.'."\n" ."\n" .'> '."\n" ."\n" .'* To downgrade a subscription instance, you must set this parameter to **DOWNGRADE**.'."\n" ."\n" .'* If the price of an instance increases after its configurations are changed, the instance is upgraded. If the price decreases, the instance is downgraded. For example, the price of an 8 GB read/write splitting instance with five read replicas is higher than that of a 16 GB cluster instance. If you want to change a 16 GB cluster instance to an 8 GB read/write splitting instance with five read replicas, you must upgrade the instance.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'enumValueTitles' => ['DOWNGRADE' => 'DOWNGRADE', 'UPGRADE' => 'UPGRADE'], 'example' => 'DOWNGRADE', 'default' => 'UPGRADE', 'enum' => ['UPGRADE', 'DOWNGRADE', 'AUTO'], 'title' => '', ], ], [ 'name' => 'MajorVersion', 'in' => 'query', 'schema' => [ 'description' => 'The major version of the classic instance that you want to upgrade. Valid values: **2.8**, **4.0**, and **5.0**.'."\n" ."\n" .'> The **InstanceClass** parameter is required when you upgrade the instance version. This parameter indicates that you can upgrade the instance version only when you update the instance specifications. If you only need to upgrade the instance version, call the [ModifyInstanceMajorVersion](~~473776~~) operation.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => '5.0', 'enum' => ['2.8', '4.0', '5.0', '6.0'], 'title' => '', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''], ], [ 'name' => 'SourceBiz', 'in' => 'query', 'schema' => ['description' => 'The source of the operation. This parameter is used only for internal maintenance. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SDK', 'title' => ''], ], [ 'name' => 'ShardCount', 'in' => 'query', 'schema' => ['description' => 'The number of shards. This parameter is applicable only to cloud-native cluster instances.'."\n" ."\n" .'> '."\n" ."\n" .'* If you want to change a cloud-native cluster instance to a standard instance, you must explicitly set the ShardCount parameter to 1 and specify the specifications of the master-replica instance.'."\n" ."\n" .'* To change a cloud-native standard instance to a cluster instance, you must explicitly set the ShardCount parameter to a value greater than 1 and specify the specifications of the cluster instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '4092', 'minimum' => '1', 'example' => '8', 'title' => ''], ], [ 'name' => 'ReplicaCount', 'in' => 'query', 'schema' => ['description' => 'The number of replica nodes in the primary zone. This parameter is applicable only to cloud-native multi-replica cluster instances. Valid values: 1 to 4.'."\n" ."\n" .'> '."\n" ."\n" .'* The sum of the values of this parameter and the SlaveReplicaCount parameter cannot be greater than 4.'."\n" ."\n" .'* You can specify either ReplicaCount or ReadOnlyCount.'."\n" ."\n" .'* A master-replica instance cannot contain multiple replica nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ 'name' => 'SlaveReplicaCount', 'in' => 'query', 'schema' => ['description' => 'The number of replica nodes in the secondary zone when you create a cloud-native multi-replica cluster instance that is deployed across multiple zones. The sum of the values of this parameter and the ReplicaCount parameter cannot be greater than 4.'."\n" ."\n" .'> When you create a cloud-native multi-replica cluster instance that is deployed across multiple zones, you must specify both SlaveReplicaCount and SecondaryZoneId.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ 'name' => 'ReadOnlyCount', 'in' => 'query', 'schema' => ['description' => 'The number of read replicas in the primary zone. Valid values: 0 to 5. This parameter applies only to the following scenarios:'."\n" ."\n" .'* If the instance is a cloud-native standard instance, you can set this parameter to a value greater than 0 to enable the read/write splitting architecture.'."\n" .'* If the instance is a cloud-native read/write splitting instance, you can use this parameter to customize the number of read replicas. You can also set this parameter to 0 to disable the read/write splitting architecture and switch the instance to the standard architecture.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9', 'minimum' => '0', 'example' => '5', 'title' => ''], ], [ 'name' => 'SlaveReadOnlyCount', 'in' => 'query', 'schema' => ['description' => 'The number of read replicas in the secondary zone when you create a read/write splitting instance that is deployed across multiple zones. Valid values: 1 to 9. The sum of the values of this parameter and the ReadOnlyCount parameter cannot be greater than 9.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9', 'minimum' => '0', 'example' => '2', 'title' => ''], ], [ 'name' => 'ForceTrans', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable forced transmission during a configuration change. Valid values:'."\n" ."\n" .'* **false** (default): Before the configuration change, the system checks the minor version of the instance. If the minor version of the instance is outdated, an error is reported. You must update the minor version of the instance and try again.'."\n" .'* **true**: The system skips the version check and directly performs the configuration change.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the node. Valid values:'."\n" ."\n" .'* **MASTER_SLAVE**: high availability (master-replica)'."\n" .'* **STAND_ALONE**: standalone'."\n" .'* **double**: master-replica'."\n" .'* **single**: standalone'."\n" ."\n" .'> To create a cloud-native instance, set this parameter to **MASTER_SLAVE** or **STAND_ALONE**. To create a classic instance, set this parameter to **double** or **single**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MASTER_SLAVE', 'enum' => ['MASTER_SLAVE', 'STAND_ALONE', 'double', 'single'], 'title' => '', ], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => [ 'description' => 'The storage type. Valid values: **essd_pl1**, **essd_pl2**, and **essd_pl3**.'."\n" ."\n" .'> This parameter is required only when you set the **InstanceType** parameter to **tair_essd** to create an ESSD-based instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'essd_pl1', 'enum' => ['essd_pl1', 'essd_pl2', 'essd_pl3'], 'title' => '', ], ], [ 'name' => 'Storage', 'in' => 'query', 'schema' => ['description' => 'The storage capacity of the ESSD/SSD-based instance. The valid values vary based on the instance type. For more information, see [ESSD/SSD-based instances](~~2527111~~).'."\n" ."\n" .'> This parameter is required only when you set the **InstanceType** parameter to **tair_essd** to create an ESSD-based instance. If you create a Tair **SSD**-based instance, the Storage parameter is automatically specified based on predefined specifications. You do not need to specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '20722623431****', 'title' => ''], 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0DA1D7EF-C80D-432C-8758-7D225182626B', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'PaymentMethodNotFound', 'errorMessage' => 'No payment method has been registered on the account.', 'description' => ''], ['errorCode' => 'HasRenewChangeOrder', 'errorMessage' => 'This instance has a renewChange order.', 'description' => ''], ['errorCode' => '%s', 'errorMessage' => 'Warn: {%s} are not supported after upgraded. you can set forceUpgrade=true to force upgrade.', 'description' => ''], ['errorCode' => 'GdcInstanceNotSupport', 'errorMessage' => 'The gdc custins trans not support.', 'description' => ''], ['errorCode' => 'AbnormalResourceStatusForRenew', 'errorMessage' => 'Abnormal resource status for renew.', 'description' => ''], ['errorCode' => 'MissingRedisShardingUnsupportPerfItem', 'errorMessage' => 'The metadb is missing redis sharding unsupoort command perf item.', 'description' => ''], ['errorCode' => 'IllegalParamError', 'errorMessage' => 'Action or resource must not be null.', 'description' => ''], ['errorCode' => 'IncorrectTargetMajorVersion', 'errorMessage' => 'Current target majorversion does not support this operation.', 'description' => 'the current operation does not support the specified target major version. make sure that the specified target major version is greater than the current major version of the instance.'], ['errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', 'description' => 'The operation is not supported by the minor version of the instance. Update the instance to the latest minor version and try again.'], ['errorCode' => 'DirectTargetLevelNotSupport', 'errorMessage' => 'The direct custins tranfer target instance level does not support.', 'description' => ''], ['errorCode' => 'DirectTransPreCheckError', 'errorMessage' => 'The direct custins trans pre check IsAddReduceNodes error.', 'description' => ''], ['errorCode' => 'DtsOpendNotSupportTrans', 'errorMessage' => 'The custins DtsSyncStatus opend does not support trans.', 'description' => ''], ['errorCode' => 'DirectTransNodeDoubleLevelError', 'errorMessage' => 'The direct custins tranfer node double target level error.', 'description' => 'When adjusting only the number of shards for directly connected instances and global multi-active instances, you need to specify 2 or 0.5 times the original number of shards.'], ['errorCode' => 'DirectTransUpgradeMajorVersionNotSupport', 'errorMessage' => 'The direct custins tranfer does not support upgrade major version.', 'description' => ''], ], 403 => [ ['errorCode' => 'TargetMemoryLessThanCurrentUsed', 'errorMessage' => 'The target instance memory size below the current instance used memory.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20722623431****\\",\\n \\"RequestId\\": \\"0DA1D7EF-C80D-432C-8758-7D225182626B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tA4828C10-AF0A-4CD7-8FBE-737C6CC1193E\\n\\t20722623431****\\n","errorExample":"\\n 202636204910941\\n 426F1356-B6EF-4DAD-A1C3-DE53B9DAF586\\n"}]', 'title' => 'ModifyInstanceSpec', 'description' => '> For more information about the procedure, impacts, limits, and fees of this operation, see [Change the configurations of an instance](~~26353~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-12-04T02:33:13.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-11-06T11:33:36.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-03-21T09:44:27.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-29T03:36:55.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-12-27T03:37:29.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-04T12:58:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-02-22T15:01:44.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-12-14T08:12:20.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2021-12-08T07:53:00.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-03T06:40:41.000Z', 'description' => 'Error codes changed, Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceSpec'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceSpec', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'ModifyInstanceTDE' => [ 'summary' => 'Enables transparent data encryption (TDE) for a Tair (Redis OSS-compatible) instance. You can use existing custom keys.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56488', 'abilityTreeNodes' => ['FEATUREkvstoreDER7E8', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreZ21KYW', 'FEATUREkvstoreJ7QDWH'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'TDEStatus', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable TDE. Set the value to **Enabled**.'."\n" ."\n" .'> TDE cannot be disabled after it is enabled. Before you enable it, evaluate whether this feature affects your business. For more information, see [Enable TDE](~~265913~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Enabled', 'title' => ''], ], [ 'name' => 'EncryptionName', 'in' => 'query', 'schema' => ['description' => 'The encryption algorithm. Default value: AES-CTR-256.'."\n" ."\n" .'> This parameter is available only if the **TDEStatus** parameter is set to **Enabled**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AES-CTR-256', 'title' => ''], ], [ 'name' => 'EncryptionKey', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom key. You can call the [DescribeEncryptionKeyList](~~473860~~) operation to query the key ID.'."\n" ."\n" .'> '."\n" ."\n" .'* If you do not specify this parameter, [Key Management Service (KMS)](~~28935~~) automatically generates a key.'."\n" ."\n" .'* To create a custom key, you can call the [CreateKey](~~28947~~) operation of the KMS API.', 'type' => 'string', 'required' => false, 'example' => 'ad463061-992d-4195-8a94-ed63********', 'title' => ''], ], [ 'name' => 'RoleArn', 'in' => 'query', 'schema' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that you want to attach to your Tair (Redis OSS-compatible) instance. The ARN must be in the format of `acs:ram::$accountID:role/$roleName`. After the role is attached, your Tair (Redis OSS-compatible) instance can use KMS.'."\n" ."\n" .'> '."\n" ."\n" .'* `$accountID`: the ID of the Alibaba Cloud account. To view the account ID, log on to the Alibaba Cloud console, move the pointer over your profile picture in the upper-right corner of the page, and then click **Security Settings**.'."\n" ."\n" .'* `$roleName`: the name of the RAM role. Replace $roleName with **AliyunRdsInstanceEncryptionDefaultRole**.', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter InstanceName is not valid.', 'description' => ''], ['errorCode' => 'TaskExists', 'errorMessage' => 'Specified task have existed.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t5D622714-AEDD-4609-9167-F5DDD3D1****\\r\\n","errorExample":""}]', 'title' => 'ModifyInstanceTDE', 'description' => '> For more information about TDE and the impact of TDE, see [Enable TDE](~~265913~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-09-14T02:23:34.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-02T02:42:53.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceTDE'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceTDE', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:TDEStatus', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'ModifyInstanceVpcAuthMode' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56490', 'abilityTreeNodes' => ['FEATUREkvstore4XSUU7', 'FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreZ21KYW', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'VpcAuthMode', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to disable password-free access. Valid values:'."\n" ."\n" .'* **Open**: disables password-free access.'."\n" .'* **Close**: enables password-free access.'."\n" ."\n" .'> Default value: **Open**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Close', 'enum' => ['Open', 'Close', 'OPEN', 'CLOSE'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABAF95F6-35C1-4177-AF3A-70969EBD****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'ParamNotSupportedForCurrentVersion', 'errorMessage' => 'Parameter is not supported for current version.', 'description' => ''], ], ], 'title' => 'ModifyInstanceVpcAuthMode', 'summary' => 'Enables or disables password-free access for a Tair (Redis OSS-compatible) instance. This way, you can connect to a database in a convenient and secure manner.', 'description' => 'When the password-free access feature is enabled, Elastic Compute Service (ECS) instances in the same virtual private cloud (VPC) can connect to the Tair instance without a password. You can also use the username and password to connect to the Tair instance.'."\n" ."\n" .'> The Tair instance is deployed in a VPC. For more information, see [Enable password-free access](~~85168~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceVpcAuthMode'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceVpcAuthMode', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:VpcAuthMode', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ABAF95F6-35C1-4177-AF3A-70969EBD****\\"\\n}","errorExample":"{ \\n \\"RequestId\\":\\"29896E96-E8C4-4F24-868A-6xxxxxxxx3\\"\\n}"},{"type":"xml","example":"\\n ABAF95F6-35C1-4177-AF3A-70969EBD****\\n","errorExample":"\\n EFC9161F-15E3-4A6E-8A99-Cxxxxxxxxx4\\n"}]', ], 'ModifyIntranetAttribute' => [ 'summary' => 'Temporarily adjusts the internal bandwidth of a Tair (Redis OSS-compatible) instance that is deployed in a dedicated cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56491', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'BandWidth', 'in' => 'query', 'schema' => ['description' => 'The amount of bandwidth that you want to add. Unit: Mbit/s. The value must be an integer greater than or equal to 0. In most cases, the maximum bandwidth that can be added can be two times the default maximum bandwidth of the current instance type. For more information about the bandwidth specifications supported by different instance types, see [Overview](~~26350~~). The bandwidth is also subject to the following limits:'."\n" ."\n" .'* The bandwidth of an individual instance cannot exceed 75% of the bandwidth of the host. For more information about the host specifications and bandwidth, see [Instance types of hosts](~~206343~~).'."\n" .'* The total bandwidth of all of the instances on the host cannot exceed 150% of the bandwidth of the host. You can configure resource overcommitment to handle traffic spikes. For more information, see [Configure resource overcommitment to reduce costs](~~183798~~).'."\n" ."\n" .'> If you do not specify this parameter for a standard instance, the bandwidth of the instance is set to two times that of the current bandwidth.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the data node. You can call the [DescribeClusterMemberInfo](~~473783~~) operation to query the node ID. Separate multiple IDs with commas (,).'."\n" ."\n" .'> This parameter is required if the instance is a [cluster](~~52228~~) instance.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****-db-0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '97AC8948-D7E4-457E-BE03-850CF04E****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"97AC8948-D7E4-457E-BE03-850CF04E****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 97AC8948-D7E4-457E-BE03-850CF04E****\\r\\n","errorExample":""}]', 'title' => 'ModifyIntranetAttribute', 'description' => '> '."\n" ."\n" .'* This operation is applicable only to an instance that is deployed in a dedicated cluster. To adjust the bandwidth of a standard instance, call the [EnableAdditionalBandwidth](~~473771~~) operation.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-03-25T11:17:40.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIntranetAttribute'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyIntranetAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'ModifyParameterGroup' => [ 'summary' => 'Modifies the settings of a parameter template.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '178977', 'abilityTreeNodes' => ['FEATUREkvstoreDVVZYL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou', 'title' => ''], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => ['description' => 'The service category. Valid values:'."\n" ."\n" .'* **standard**: Redis Open-Source Edition'."\n" .'* **enterprise**: Tair (Enterprise Edition)'."\n", 'type' => 'string', 'required' => true, 'example' => 'enterprise', 'title' => ''], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => ['description' => 'The parameter template ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sys-001****', 'title' => ''], ], [ 'name' => 'ParameterGroupDesc', 'in' => 'query', 'schema' => ['description' => 'The description of the parameter template. The description must be 0 to 200 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'ParameterGroupName', 'in' => 'query', 'schema' => ['description' => 'The new name of the parameter template. The name must meet the following requirements:'."\n" ."\n" .'* The name can contain letters, digits, and underscores (\\_). It must start with a letter and cannot contain Chinese characters.'."\n" .'* The name can be 8 to 64 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testGroupName', 'title' => ''], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => ['description' => 'A JSON-formatted object that specifies the parameter-value pairs. Format: {"Parameter 1":"Value 1","Parameter 2":"Value 2"...}. The specified value overwrites the original content.'."\n" ."\n" .'> The parameters that can be added for different editions are displayed in the console.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"hz":"12"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AD425AD3-CC7B-4EE2-A5CB-2F61BA73****'], 'ParamGroupId' => ['description' => 'The parameter template ID.'."\n", 'type' => 'string', 'example' => 'testGroupName', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD425AD3-CC7B-4EE2-A5CB-2F61BA73****\\",\\n \\"ParamGroupId\\": \\"testGroupName\\"\\n}","type":"json"}]', 'title' => 'ModifyParameterGroup', 'changeSet' => [ ['createdAt' => '2024-08-06T06:48:54.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-06-17T11:39:39.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameterGroup'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyParameterGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifyResourceGroup' => [ 'summary' => 'Modifies the resource group to which a Tair (Redis OSS-compatible) instance belongs.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56498', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the generated token is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group to which you want to move the instance.'."\n" ."\n" .'> * You can query resource group IDs by using the Tair (Redis OSS-compatible) console or by calling the [ListResourceGroups](~~158855~~) operation. For more information, see [View basic information of a resource group](~~151181~~).'."\n" .'> * Before you modify the resource group to which an instance belongs, you can call the [ListResources](~~158866~~) operation to view the resource group of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-acfmyiu4ekp****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ResourceGroupId.InValid', 'errorMessage' => 'The Specified resource group id is not found.', 'description' => ''], ], 403 => [ ['errorCode' => 'ServiceAccount.NoPermission', 'errorMessage' => 'Service account has no auth to do this action.', 'description' => ''], ], [ ['errorCode' => 'EntityNotExists.Resource', 'errorMessage' => 'The resource does not EXIST.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t5D622714-AEDD-4609-9167-F5DDD3D1****\\r\\n","errorExample":""}]', 'title' => 'ModifyResourceGroup', 'description' => 'You can also perform this operation in the [Resource Management](https://resourcemanager.console.aliyun.com/resource-center) console. For more information, see [Transfer resources across resource groups](~~94487~~).'."\n" ."\n" .'> Resource Group allows you to sort resources owned by your Alibaba Cloud account into groups. This simplifies the resource and permission management within your Alibaba Cloud account. For more information, see [What is Resource Management?](~~94475~~)'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-24T06:26:44.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-04-23T06:05:03.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2023-03-02T02:42:53.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyResourceGroup'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyResourceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModifySecurityGroupConfiguration' => [ 'summary' => 'Resets the security groups that are added to the whitelists of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56499', 'abilityTreeNodes' => ['FEATUREkvstoreN9BAYI'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'SecurityGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the security group that you want to manage. You can specify up to 10 security groups. Separate multiple security group IDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sg-bpcfmyiu4ekp****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '147CAC09-E8C6-43F8-9599-982A43D6****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', 'description' => ''], ['errorCode' => 'AssociatedEcsSecurityGroupIdQuotaExceed', 'errorMessage' => 'SecurityGroupId参数超过能使用的最大数量.', 'description' => ''], ['errorCode' => 'MissingInstanceId', 'errorMessage' => 'InstanceId is mandatory for this action.', 'description' => ''], ['errorCode' => 'InvalidParam', 'errorMessage' => 'Specified ecs security group id is not valid.', 'description' => ''], ['errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'the Specified Zone not supported.', 'description' => ''], ], 403 => [ ['errorCode' => 'AssociatedEcsSecurityGroupId.QuotaExceed', 'errorMessage' => 'SecurityGroupIdQuotaExceeded exceeding the allowed amount of SecurityGroupId.', 'description' => ''], ], [ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter “DBInstanceId” that is mandatory for processing this request is not supplied.', 'description' => ''], ['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', 'description' => ''], ['errorCode' => 'InvalidRegionZoneNotFound', 'errorMessage' => 'Specified Region does not exist in RDS.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"147CAC09-E8C6-43F8-9599-982A43D6****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 147CAC09-E8C6-43F8-9599-982A43D6****\\r\\n","errorExample":""}]', 'title' => 'ModifySecurityGroupConfiguration', 'description' => '> After you call this operation, the security groups that are added to the whitelists of the Tair instance are deleted, and the security group specified by the **SecurityGroupId** parameter is added to the whitelists. For more information about how to reset security groups in the Tair console, see [Add security groups](~~148267~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-03-25T11:17:40.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifySecurityGroupConfiguration'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifySecurityGroupConfiguration', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ], ], ], 'ModifySecurityIps' => [ 'summary' => 'Configures an IP address whitelist for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56500', 'abilityTreeNodes' => ['FEATUREkvstoreFPM1AL'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'SecurityIps', 'in' => 'query', 'schema' => ['description' => 'The IP addresses in the whitelist. Up to 1,000 IP addresses can be specified in a whitelist. Separate multiple IP addresses with a comma (,). Specify an IP address in the 0.0.0.0/0, 10.23.12.24, or 10.23.12.24/24 format. In CIDR block 10.23.12.24/24, /24 specifies the length of the prefix of an IP address. The prefix length ranges from 1 to 32.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100.64.***.0/24,10.101.11.***', 'title' => ''], ], [ 'name' => 'SecurityIpGroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the IP address whitelist.'."\n" .'>You cannot modify the whitelist that is generated by the system. If you do not specify this parameter, the default whitelist is modified by default.>', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ 'name' => 'SecurityIpGroupAttribute', 'in' => 'query', 'schema' => ['description' => 'By default, this parameter is left empty. The attribute of the whitelist. The console does not display the whitelist whose value of this parameter is **hidden**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hidden', 'title' => ''], ], [ 'name' => 'ModifyMode', 'in' => 'query', 'schema' => ['description' => 'The method that is used to modify the whitelist. Valid values:'."\n" ."\n" .'* **Cover** (default): overwrites the original whitelist.'."\n" .'* **Append**: appends data to the whitelist.'."\n" .'* **Delete**: deletes the whitelist.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Append', 'default' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AAAF99B1-69ED-4E80-8CD5-272C09E4****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Forbbiden.MinorVersion', 'errorMessage' => 'The operation is not permitted for current minor version. ', 'description' => ''], ['errorCode' => 'InvalidGroupName.Format', 'errorMessage' => 'Sepecified group name is not valid.', 'description' => ''], ['errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', 'description' => 'The current request conflicts with another request, please try again later.'], ], 404 => [ ['errorCode' => 'InvalidSecurityIPList.NotFound', 'errorMessage' => 'Specified same security IP does not exist or at least one security IP need.', 'description' => 'The same IP as the specified IP was not found in the whitelist group, or no IP was passed in.'], ], 409 => [ ['errorCode' => 'SecurityIPList.Duplicate', 'errorMessage' => 'Specified same security IP already exists.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AAAF99B1-69ED-4E80-8CD5-272C09E4****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n AAAF99B1-69ED-4E80-8CD5-272C09E4****\\n","errorExample":"{\\n\\"RequestId\\" : \\"AAAF99B1-69ED-4E80-8CD5-272C09E46ACF\\"\\n}"}]', 'title' => 'ModifySecurityIps', 'description' => 'You can also modify the whitelists of an instance in the Tair (Redis OSS-compatible) console. For more information, see [Configure a whitelist for an instance](~~56464~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySecurityIps'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifySecurityIps', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'ModifyTaskInfo' => [ 'summary' => 'Modifies the task information, such as the task execution time.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '141280', 'abilityTreeNodes' => ['FEATUREkvstoreJ3DM1I'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region where the instance is deployed.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The task ID. Separate multiple task IDs with commas (,). You can specify up to 30 task IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 't-0mq3kfhn8i1nlt****', 'title' => ''], ], [ 'name' => 'StepName', 'in' => 'query', 'schema' => ['description' => 'The name of the current step.'."\n", 'type' => 'string', 'required' => false, 'example' => 'do_pause', 'title' => ''], ], [ 'name' => 'TaskAction', 'in' => 'query', 'schema' => ['description' => 'The action name. Set the value to **modifySwitchTime**. The value specifies that you want to change the switching time or restoration time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'modifySwitchTime', 'title' => ''], ], [ 'name' => 'ActionParams', 'in' => 'query', 'schema' => ['description' => 'The JSON-formatted parameters related to the action. Set this parameter to `{"recoverMode": "xxx", "recoverTime": "xxx"}` if the **TaskAction** parameter is set to **modifySwitchTime**.'."\n" ."\n" .'* **recoverMode**: specifies the restoration mode for the task. Valid values:'."\n" ."\n" .' * **timePoint**: performs the task at the specified point in time.'."\n" .' * **immediate**: performs the task immediately.'."\n" .' * **maintainTime**: performs the task within the maintenance window.'."\n" ."\n" .'* **recoverTime**: specifies the point in time for restoration. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. This parameter is required if the **recoverMode** parameter is set to **timePoint**.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"recoverMode":"immediate"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2B98499B-E62B-56D4-8D7F-3D6D4DB260F2', 'title' => ''], 'ErrorTaskId' => ['description' => 'The ID of the failed task. This parameter is returned if a task fails.', 'type' => 'string', 'example' => 't-0mqaj5hnyofczv****', 'title' => ''], 'SuccessCount' => ['description' => 'The number of completed tasks.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], 'ErrorCode' => ['description' => 'The error code returned if a task fails.'."\n", 'type' => 'string', 'example' => 'mst.errorcode.success.errormessage', 'title' => ''], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B98499B-E62B-56D4-8D7F-3D6D4DB260F2\\",\\n \\"ErrorTaskId\\": \\"t-0mqaj5hnyofczv****\\",\\n \\"SuccessCount\\": \\"2\\",\\n \\"ErrorCode\\": \\"mst.errorcode.success.errormessage\\"\\n}","type":"json"}]', 'title' => 'ModifyTaskInfo', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTaskInfo'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyTaskInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'RebootProxy' => [ 'summary' => 'Restarts the proxy node of a running Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56503', 'abilityTreeNodes' => ['FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1ymwrhvq79zj****', 'title' => ''], ], [ 'name' => 'ProxyList', 'in' => 'query', 'schema' => ['description' => 'The IDs of the proxy nodes that you want to restart or rebuild. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '90310144,90310144', 'title' => ''], ], [ 'name' => 'RebootMode', 'in' => 'query', 'schema' => [ 'description' => 'The type of operation that you want to perform. Valid values:'."\n" ."\n" .'* **reboot**: restarts the proxy node.'."\n" .'* **rebuild**: rebuilds the proxy node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'reboot', 'enum' => ['reboot', 'rebuild'], 'title' => '', ], ], [ 'name' => 'ProxyNodeList', 'in' => 'query', 'schema' => ['description' => 'The IDs of the hosts on which the proxy nodes are deployed. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '36912280,36912282', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"561AFBF1-BE20-44DB-9BD1-6988B53E****\\"\\n}","type":"json"}]', 'title' => 'RebootProxy', 'description' => 'This operation supports only instances that use the read/write splitting architecture or the cluster architecture in proxy mode. For more information, see [Restart or rebuild proxy nodes](~~164224~~).'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebootProxy'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:RebootProxy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ReleaseDirectConnection' => [ 'summary' => 'Releases the private endpoint of a Tair (Redis OSS-compatible) cluster instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'NetTypeNotExists', 'errorMessage' => 'Specified net type not existed.', 'description' => ''], ], 403 => [ ['errorCode' => 'InstanceStatus.NotSupport', 'errorMessage' => 'Instance status does not support this operation.', 'description' => ''], ], [ ['errorCode' => 'InvalidDbInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t5D622714-AEDD-4609-9167-F5DDD3D1****\\r\\n","errorExample":""}]', 'title' => 'ReleaseDirectConnection', 'description' => 'In direct connection mode, clients can bypass proxy nodes and use private endpoints to connect to ApsaraDB for Redis instances. This is similar to the connection to a native Redis cluster. The direct connection mode can reduce communication overheads and the response time of ApsaraDB for Redis. For more information, see [Enable the direct connection mode](~~146901~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReleaseDirectConnection'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:ReleaseDirectConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'ReleaseInstancePublicConnection' => [ 'summary' => 'Releases the public endpoint of a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREkvstoreS0D17V'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'CurrentConnectionString', 'in' => 'query', 'schema' => ['description' => 'The public endpoint to be released.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '88F850B5-CC68-48B4-83CA-5497C3C191DE', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingInstanceId', 'errorMessage' => 'InstanceId is mandatory for this action.', 'description' => ''], ['errorCode' => 'MissingConnectionString', 'errorMessage' => 'CurrentConnectionString is mandatory for this action.', 'description' => ''], ['errorCode' => 'AtLeastOneNetTypeExists', 'errorMessage' => 'Current DB instance net type does not support this operation.', 'description' => 'The network type of the current instance does not support this operation'], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"88F850B5-CC68-48B4-83CA-5497C3C191DE\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 88F850B5-CC68-48B4-83CA-5497C3C191DE\\r\\n","errorExample":""}]', 'title' => 'ReleaseInstancePublicConnection', 'description' => 'You can also release the public endpoint for an instance in the Tair (Redis OSS-compatible) console. For more information, see [Release public endpoints](~~125424~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstancePublicConnection'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:ReleaseInstancePublicConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'RemoveSubInstance' => [ 'summary' => 'Removes a child instance from a distributed instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t5D622714-AEDD-4609-9167-F5DDD3D1****\\r\\n","errorExample":""}]', 'title' => 'RemoveSubInstance', 'description' => 'The operation that you want to perform. Set the value to **RemoveSubInstance**.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-05-05T07:45:09.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSubInstance'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:RemoveSubInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'RenewAdditionalBandwidth' => [ 'summary' => 'This operation is not recommended now. The billing method for bandwidth of a Tair (Redis OSS-compatible) instance is changed to pay-as-you-go.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => ['description' => 'The ID of the coupon.'."\n", 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'default' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable automatic payment. Default value: true. Valid values:'."\n" ."\n" .'* **true**: enables automatic payment.'."\n" .'* **false**: disables automatic payment. If automatic payment is disabled, you must perform the following steps to complete the payment in the Tair (Redis OSS-compatible) console: In the top navigation bar, choose **Expenses** > **Renewal Management**. In the left-side navigation pane, click **Orders**. On the **Orders** page, find the order and complete the payment.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'default' => 'true', 'title' => ''], ], [ 'name' => 'OrderTimeLength', 'in' => 'query', 'schema' => ['description' => 'The validity period of the bandwidth that you purchase. Unit: days. Valid values: **1**, **2**, **3**, **7**, **14**, **30**, **60**, **90**, **180**, **365**, **730**, **1095**, and **1825**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '30', 'default' => '', 'title' => ''], ], [ 'name' => 'SourceBiz', 'in' => 'query', 'schema' => ['description' => 'The source of the operation. This parameter is used only for internal maintenance. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SDK', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '2084452111111', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D622714-AEDD-4609-9167-F5DDD3D1**** ', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"2084452111111\\",\\n \\"RequestId\\": \\"D622714-AEDD-4609-9167-F5DDD3D1****\\\\t\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n D622714-AEDD-4609-9167-F5DDD3D1****\\r\\n 2084452111111\\r\\n","errorExample":""}]', 'title' => 'RenewAdditionalBandwidth', 'description' => 'You can adjust the bandwidth of an instance in the Tair (Redis OSS-compatible) console. For more information, see [Adjust the bandwidth of an instance](~~102588~~). You can also call the [EnableAdditionalBandwidth](~~473771~~) operation to purchase bandwidth for an instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-07-20T02:32:40.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewAdditionalBandwidth'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:RenewAdditionalBandwidth', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'RenewInstance' => [ 'summary' => 'Renews a Tair (Redis OSS-compatible) subscription instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Capacity', 'in' => 'query', 'schema' => ['description' => 'The storage capacity of the instance. Unit: MB. When you renew the instance, you can specify this parameter to change specifications of the instance.'."\n" ."\n" .'> To change the specifications when you renew the instance, you must specify at least one of the `Capacity` and `InstanceClass` parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => ['description' => 'The instance type code. For more information, see [Instance specifications overview](~~26350~~). When you renew the instance, you can specify this parameter to change specifications of the instance.'."\n" ."\n" .'> To change the specifications when you renew the instance, you must specify at least one of the `Capacity` and `InstanceClass` parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The renewal period. Valid values: **1**, 2, 3, 4, 5, 6, 7, 8, **9**, **12**, **24**, and **36**. Unit: months.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '6', 'title' => ''], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable automatic payment. Default value: true. Valid values:'."\n" ."\n" .'* **true**: enables automatic payment.'."\n" .'* **false**: disables automatic payment.'."\n" ."\n" .'If you select false, you must choose **Expenses** > **Renewal Management** in the top navigation bar. In the left-side navigation pane, click **Orders**. Find the specified order and pay for it.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', 'title' => ''], ], [ 'name' => 'FromApp', 'in' => 'query', 'schema' => ['description' => 'The source of the request. The default value is **OpenAPI** and cannot be changed.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OpenAPI', 'default' => 'OpenApi', 'title' => ''], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => ['description' => 'The ID of the promotional event or business information.'."\n", 'type' => 'string', 'required' => false, 'example' => '000000000', 'title' => ''], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => ['description' => 'The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'default' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token is case-sensitive. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.6823317918435086', 'title' => ''], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'* **true**: enables auto-renewal. The instance is renewed based on the specified renewal duration. For example, if you set the renewal duration to three months, you are charged for three months of service each time the instance is automatically renewed.'."\n" .'* **false** (default): disables auto-renewal.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => 'The end time of the order.'."\n", 'type' => 'string', 'example' => '2019-02-19T00:00:00Z', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2222245-222A-4155-9349-E22222****', 'title' => ''], 'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '111111111111111', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'HasRenewChangeOrder', 'errorMessage' => 'This instance has a renewChange order.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-02-19T00:00:00Z\\",\\n \\"RequestId\\": \\"2222245-222A-4155-9349-E22222****\\",\\n \\"OrderId\\": \\"111111111111111\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 111111111111111\\r\\n 4D425645-A8BA-4155-9349-2222222****\\r\\n 2019-02-19T00:00:00Z\\r\\n","errorExample":""}]', 'title' => 'RenewInstance', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-01-30T11:27:44.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-03-15T02:57:49.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewInstance'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:RenewInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'description' => 'This operation is applicable only to subscription instances.'."\n", ], 'ResetAccountPassword' => [ 'summary' => 'Resets the password of an account for a Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56514', 'abilityTreeNodes' => ['FEATUREkvstoreXSBQ72'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance to which the account belongs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The name of the account. You can call the [DescribeAccounts](~~DescribeAccounts~~) operation to obtain the name of the account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'demoaccount', 'title' => ''], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => 'The new password for the account. The password must be 8 to 32 characters in length. It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include `!@ # $ % ^ & * ( ) _ + - =`'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'uWonno_221****', 'title' => ''], ], [ 'name' => 'SourceBiz', 'in' => 'query', 'schema' => ['description' => 'This parameter is used only for internal maintenance. You do not need to specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SDK', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8BE02313-5395-4EBE-BAE7-E90A053F****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidAccountName.Duplicate', 'errorMessage' => 'Specified AccountName already exists in this instance.', 'description' => 'The error message returned because the account already exists.'], ['errorCode' => 'InvalidAccountName.Format', 'errorMessage' => 'Specified AccountName is not valid.', 'description' => ''], ['errorCode' => 'InvalidEngineVersion.Format', 'errorMessage' => 'Current EngineVersion does not support operations.', 'description' => 'The operation is not supported while the instance runs this engine version.'], ['errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified AccountPassword is not valid.', 'description' => ''], ['errorCode' => 'TaskExists', 'errorMessage' => 'Specified task have existed.', 'description' => ''], ], ], 'title' => 'ResetAccountPassword', 'description' => '> Only Tair (Redis OSS-compatible) instances of Redis 4.0 or later are supported.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-07-11T12:25:18.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPassword'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ResetAccountPassword', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8BE02313-5395-4EBE-BAE7-E90A053F****\\"\\n}","errorExample":"{\\n\\t\\"RequestId\\": \\"8BE02313-5395-4EBE-BAE7-E90A053F1E07\\"\\n}"},{"type":"xml","example":"\\n 8BE02313-5395-4EBE-BAE7-E90A053F****\\n","errorExample":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\n"}]', ], 'RestartInstance' => [ 'summary' => 'Restarts a running Tair (Redis OSS-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56515', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want to restart the instance. Default value: Immediately. Valid values:'."\n" ."\n" .'* **Immediately**: immediately restarts the instance.'."\n" .'* **MaintainTime**: restarts the instance during the maintenance window.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Immediately', 'default' => '0', 'enum' => ['0', '1', 'Immediately', 'MaintainTime'], 'title' => '', ], ], [ 'name' => 'UpgradeMinorVersion', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to update to the latest minor version when the instance is restarted. Valid values:'."\n" ."\n" .'* **true**: updates the minor version.'."\n" .'* **false**: does not update the minor version.'."\n" ."\n" .'> The default value is **true**.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EFC9161F-15E3-4A6E-8A99-C33331****', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '11111****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support this operation.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EFC9161F-15E3-4A6E-8A99-C33331****\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"TaskId\\": \\"11111****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n EFC9161F-15E3-4A6E-8A99-6661****\\r\\n r-bp1zxszhcgatnx****\\r\\n 11111****\\r\\n","errorExample":""}]', 'title' => 'RestartInstance', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestartInstance'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:RestartInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ], ], ], 'RestoreInstance' => [ 'summary' => 'Restores data from a specified backup file to a Tair (Redis-compatible) instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup file. You can find backup file IDs by calling the [DescribeBackups](~~473823~~) operation.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'default' => '0', 'example' => '78241****', 'title' => ''], ], [ 'name' => 'RestoreType', 'in' => 'query', 'schema' => [ 'description' => 'The restore method. Valid values:'."\n" ."\n" .'- **0** (default): This value is deprecated.'."\n" ."\n" .'- **1**: Restores data to a specific point in time. You can set this parameter to 1 only if the [Data Flashback](~~148479~~) feature is enabled for the instance. If you set this parameter to 1, you must also specify the **RestoreTime** parameter.', 'type' => 'string', 'required' => false, 'pattern' => '^\\d+$', 'default' => '0', 'enum' => ['0', '1'], 'example' => '1', 'title' => '', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => ['description' => 'The restore point in time. Specify the time in the *yyyy-MM-dd*T*HH:mm:ss*Z format (UTC).'."\n" ."\n" .'> This point in time cannot be earlier than the time when the Data Flashback feature was enabled.', 'type' => 'string', 'required' => false, 'example' => '2021-07-06T07:25:57Z', 'title' => ''], ], [ 'name' => 'FilterKey', 'in' => 'query', 'schema' => ['description' => 'The keys to restore, which can be specified as a regular expression. To specify multiple keys, separate them with commas (,).'."\n" ."\n" .'- If you do not specify this parameter, the entire instance is restored.'."\n" ."\n" .'- If you specify this parameter, only the specified keys are restored. This feature is available only for instances that use the classic architecture.'."\n" ."\n" .'> In a regular expression, the asterisk (`*`) matches the preceding element zero or more times. For example, if you set this parameter to `h.*llo`, strings such as `hllo` and `heeeello` are matched.', 'type' => 'string', 'required' => false, 'example' => 'key:00000007198*', 'title' => ''], ], [ 'name' => 'TimeShift', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'For instances that use the classic architecture, you can apply an offset to the expiration time of restored keys. This applies whether you restore the entire instance or only specific keys. The system calculates a key\'s remaining time-to-live (TTL) at the specified flashback point in time and then adds this TTL to the `TimeShift` value to set the key\'s new expiration time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).'."\n" ."\n" .'> - This feature adjusts the expiration time for top-level keys only. It does not apply to the expiration times of elements within Tair-specific data structures, such as fields in an exHash or secondary keys (Skeys) in a Time Series (TS) data structure.'."\n" .'>'."\n" .'> - The specified time must be later than `RestoreTime` and earlier than the task submission time.', 'type' => 'string', 'required' => false, 'example' => '2021-07-06T08:25:57Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B****', 'title' => ''], ], 'description' => 'The response object.', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'ServiceNotSupport', 'errorMessage' => 'This service not supported.', 'description' => ''], ['errorCode' => 'MissingParameter', 'errorMessage' => 'Missing Required Param: BackupId or RestoreTime or RestoreType.', 'description' => ''], ['errorCode' => 'ResroreParamNotMatch', 'errorMessage' => 'restoreType is not match with backupId or restoreTime.', 'description' => ''], ['errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', 'description' => ''], ['errorCode' => 'ZoneMigrationError.StillingRunning', 'errorMessage' => 'Zone migration task is still running', 'description' => ''], ['errorCode' => 'InvalidBinlog.NotValid', 'errorMessage' => 'The available binlog is not valid in recovery time.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B****\\"\\n}","type":"json"}]', 'title' => 'RestoreInstance', 'description' => '- For Tair memory-enhanced enterprise edition instances that use the classic architecture, you can restore specified keys to a point in time with precision to the second for granular data recovery.'."\n" ."\n" .'- For all other instance types, use the [CreateInstance](~~473757~~) or [CreateTairInstance](~~473770~~) operation to restore backup data to a new instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-11-22T11:41:38.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestoreInstance'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:RestoreInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'SwitchInstanceHA' => [ 'summary' => 'Performs a primary/secondary switchover (switches node roles). This operation can be used for disaster recovery drills and nearest access for applications in multi-zone deployment scenarios.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '56519', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. You can call [DescribeInstances](~~473778~~) to query the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the data shard node. You can call [DescribeRoleZoneInfo](~~473782~~) to obtain the CustinsId parameter. Separate multiple data shard node IDs with commas (,). To specify all nodes, enter `all`.'."\n" .'> This parameter is available and required only when the instance uses the cluster or read/write splitting architecture.', 'type' => 'string', 'required' => false, 'example' => '56****19,56****20', 'title' => ''], ], [ 'name' => 'SwitchMode', 'in' => 'query', 'schema' => ['description' => 'The execution time. Valid values:'."\n" .'* **0**: immediately. This is the default value.'."\n" .'* **1**: during the maintenance window.'."\n" ."\n" .'> You can call [ModifyInstanceMaintainTime](~~473775~~) to modify the maintenance window of the instance.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'SwitchType', 'in' => 'query', 'schema' => [ 'description' => 'The switchover mode. Valid values:'."\n" .'* **ReliabilityPriority (default)**: Reliability is prioritized. The primary/secondary switchover is performed only when primary/secondary synchronization has no latency, which prevents data loss. In scenarios with heavy write workloads and persistent synchronization latency, this mode may cause the primary/secondary switchover to fail.'."\n" .'* **AvailablePriority**: Availability is prioritized. The primary/secondary switchover is performed immediately regardless of primary/secondary latency, which may cause minor data loss.'."\n" ."\n" .'> Evaluate your business requirements for data integrity and service availability before selecting a switchover mode.', 'enumValueTitles' => ['AvailablePriority' => 'AvailablePriority', 'ReliabilityPriority' => 'ReliabilityPriority'], 'type' => 'string', 'required' => false, 'docRequired' => false, 'default' => 'ReliabilityPriority', 'enum' => ['AvailablePriority', 'ReliabilityPriority', 'DataConsistency'], 'example' => 'ReliabilityPriority', 'title' => '', ], ], [ 'name' => 'SourceNodeId', 'in' => 'query', 'schema' => ['description' => 'The node ID of the original MASTER node in the shard.', 'type' => 'string', 'required' => false, 'example' => '52717408', 'title' => ''], ], [ 'name' => 'TargetNodeId', 'in' => 'query', 'schema' => ['description' => 'The node ID of the target MASTER node after the switchover.', 'type' => 'string', 'required' => false, 'example' => '52717403', 'title' => ''], ], [ 'name' => 'TargetShardName', 'in' => 'query', 'schema' => ['description' => 'The shard name of the instance.', 'type' => 'string', 'required' => false, 'example' => 'r-2zegk3jyxxxwixfo6c-db-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], 'TaskId' => ['type' => 'string', 'example' => '674546459', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\",\\n \\"TaskId\\": \\"674546459\\"\\n}","type":"json"}]', 'title' => 'Switch instance HA', 'description' => '> For more information about nearest access for applications in multi-zone deployment scenarios, see [Scenario examples](~~164222~~).'."\n" ."\n" .'When you call this operation, the instance must be of the high-availability or dual-replica type.'."\n" ."\n" .'Calling this operation has the following impacts:'."\n" .'* After a node role switchover is triggered, the data node being switched enters a read-only state for a few seconds and experiences a transient connection. Make sure that your application has a reconnection mechanism.'."\n" .'* While the instance is in the switching state, you cannot perform instance-level operations such as configuration changes or zone migration.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-07-20T02:32:22.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SwitchInstanceHA'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:SwitchInstanceHA', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SwitchInstanceProxy' => [ 'summary' => 'Enables or disables the proxy mode for a Tair (Redis OSS-compatible) cluster instance in a dedicated cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t5D622714-AEDD-4609-9167-F5DDD3D1****\\r\\n","errorExample":""}]', 'title' => 'SwitchInstanceProxy', 'description' => 'For more information about the proxy mode, see [Features of proxy servers](~~142959~~). Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'* The instance is created by using a dedicated cluster. For more information, see [What is ApsaraDB for MyBase?](~~141455~~)'."\n" .'* The instance uses the [cluster architecture](~~52228~~).'."\n" ."\n" .'> Before you call the SwitchInstanceProxy operation, you must call the [DescribeDedicatedClusterInstanceList](~~473867~~) operation and view the value of the **ProxyCount** response parameter to check whether the proxy mode is enabled. A value of 0 indicates that the proxy mode is disabled. A value that is greater than 0 indicates that the proxy mode is enabled.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-07-20T02:32:22.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchInstanceProxy'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:SwitchInstanceProxy', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SwitchInstanceZoneFailOver' => [ 'summary' => 'Switches an instance from the current zone to the specified zone in the event of a fault.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '240777', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'TargetZoneId', 'in' => 'query', 'schema' => ['description' => 'The ID of the destination zone.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', 'title' => ''], ], [ 'name' => 'SiteFaultTime', 'in' => 'query', 'schema' => [ 'description' => 'The duration for which the fault lasts. Unit: minutes.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* 5'."\n" .'* 10'."\n", 'type' => 'string', 'required' => false, 'example' => '5', 'enum' => ['5', '10', '30'], 'default' => '5', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2D9F3768-EDA9-4811-943E-42C8006E****'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'SwitchInstanceZoneFailOver', 'description' => '- 本接口仅适用于多（双）可用区集群架构实例。'."\n" .'- 模拟故障的节点会在稍后自动恢复。但主节点位于备可用区、备节点位于主可用区，此时可能产生实例与其他业务跨机房访问的情况。如需解决该问题，您可以在控制台服务可用性页面手动切换可用区。', 'changeSet' => [ ['createdAt' => '2025-03-31T08:33:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-31T02:06:56.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-04T02:38:07.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SwitchInstanceZoneFailOver'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:SwitchInstanceZoneFailOver', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D9F3768-EDA9-4811-943E-42C8006E****\\"\\n}","type":"json"}]', ], 'SwitchNetwork' => [ 'summary' => 'Changes the VPC or vSwitch of a Tair (Redis OSS-compatible) instance. If the instance is deployed in the classic network, the network type of the instance is changed from the classic network to VPC.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'TargetNetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type to which you want to switch. If you want to switch to VPC network, Set the value to **VPC**.', 'type' => 'string', 'required' => false, 'example' => 'VPC', 'default' => 'VPC', 'enum' => ['CLASSIC', 'VPC'], 'title' => '', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => ['description' => 'The ID of the VPC to which you want to switch. You can call the [DescribeVpcs](~~35739~~) operation to query the VPC ID.'."\n" ."\n" .'> '."\n" ."\n" .'* The VPC and the instance must be deployed in the same region.'."\n" ."\n" .'* After you set this parameter, you must also set the **VSwitchId** parameter.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vpc-bp1nme44gek34slfc****', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch that belongs to the VPC to which you want to switch. You can call the [DescribeVpcs](~~35739~~) operation to query the vSwitch ID.'."\n" ."\n" .'> The vSwitch and the instance must be deployed in the same zone.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vsw-bp1e7clcw529l773d****', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'RetainClassic', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to retain the original classic network endpoint after you switch the instance from classic network to VPC. Default value: False. Valid values:'."\n" ."\n" .'* **True**: retains the classic network endpoint.'."\n" .'* **False**: does not retain the classic network endpoint.'."\n" ."\n" .'> This parameter is available only when the network type of the instance is classic network.'."\n", 'type' => 'string', 'required' => false, 'example' => 'True', 'title' => ''], ], [ 'name' => 'ClassicExpiredDays', 'in' => 'query', 'schema' => ['description' => 'The retention period of the classic network endpoint. Valid values: **14**, **30**, **60**, and **120**. Unit: days.'."\n" ."\n" .'> '."\n" ."\n" .'* This parameter is available and required only when the **RetainClassic** parameter is set to **True**.'."\n" ."\n" .'* After you complete the switchover operation, you can also call the [ModifyInstanceNetExpireTime](~~473793~~) operation to modify the retention period of the classic network endpoint.', 'type' => 'string', 'required' => false, 'example' => '30', 'pattern' => '^\\d+$', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '578678678', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F0997EE8-F4C2-4503-9168-85177ED78C70', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidToken.Malformed', 'errorMessage' => 'The Specified parameter Token is not valid.', 'description' => ''], ['errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke vpc service failed.', 'description' => ''], ['errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify iz not support vpc.', 'description' => ''], ['errorCode' => 'IzNotSupportSwitchNetworkError', 'errorMessage' => 'Specify iz not support switch network.', 'description' => ''], ['errorCode' => 'VpcVerifyError', 'errorMessage' => 'VpcId is wrong.', 'description' => ''], ['errorCode' => 'VpcAndVSwitchNotChange', 'errorMessage' => 'VpcId and vSwitchId not change.', 'description' => 'The VpcId and vSwitchId parameter values are not changed.'], ], 403 => [ ['errorCode' => 'ResourceAlreadyExists', 'errorMessage' => 'Resource already exists.', 'description' => ''], ['errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'ip resource is conflict with other custins.', 'description' => ''], ['errorCode' => 'VpcFreePasswordNoSupport', 'errorMessage' => 'The custins opend VPCFreePassword not support this operation.', 'description' => 'This operation is not supported for the instance because the VPC secret exemption is enabled or the# no_loose_check-whitelist-always parameter is set to no at the same time.'], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"578678678\\",\\n \\"RequestId\\": \\"F0997EE8-F4C2-4503-9168-85177ED78C70\\"\\n}","errorExample":"{\\n \\"TaskId\\":\\"578678678\\",\\n \\"requestId\\":\\"F0997EE8-F4C2-4503-9168-85177ED78C70\\"\\n}"},{"type":"xml","example":"\\n 578678678\\n F0997EE8-F4C2-4503-9168-85177ED78C70\\n","errorExample":"\\n 578678678\\n F0997EE8-F4C2-4503-9168-85177ED78C70\\n"}]', 'title' => 'SwitchNetwork', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-02-26T09:46:19.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchNetwork'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:SwitchNetwork', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'SyncDtsStatus' => [ 'summary' => 'Disables configuration changes for a Tair (Redis OSS-compatible) instance before you use Data Transmission Service (DTS) to migrate or synchronize data of the instance. This prevents migration and synchronization task failures due to configuration changes.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Disables configuration changes for the instance. Valid values:'."\n" ."\n" .'* **0**: does not disable configuration changes.'."\n" .'* **1**: disables configuration changes. In this case, if you attempt to modify the configurations of the instance, the system informs you that the operation cannot be performed.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0', 'enum' => ['0', '1'], 'title' => '', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The ID of the DTS instance. You can view the ID in the [DTS console](https://dts.console.aliyun.com/).'."\n" ."\n" .'> A Tair (Redis OSS-compatible) instance may be involved in multiple data migration or synchronization tasks. If you want to cancel the restriction on the instance, you can specify this parameter to prevent repeated operation calls.', 'type' => 'string', 'required' => false, 'example' => ' dtss0611o8vv90****', 'maxLength' => 64, 'minLength' => 1, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t5D622714-AEDD-4609-9167-F5DDD3D1****\\r\\n","errorExample":""}]', 'title' => 'SyncDtsStatus', 'description' => '- 本接口仅适用于经典版实例。'."\n" .'- 数据迁移或同步任务完成后，您可以再次调用本接口，解除变配限制。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-07-20T02:32:21.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-02T02:42:53.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SyncDtsStatus'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:SyncDtsStatus', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'TagResources' => [ 'summary' => 'Adds tags to Tair (Redis OSS-compatible) instances.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The resource type. Set the value to **INSTANCE**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', 'enum' => ['INSTANCE', 'instance'], 'title' => '', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'array', 'items' => ['description' => 'The ID of the instance. You can specify multiple IDs.'."\n" ."\n" .'> This parameter indicates the ID of the **Nth** instance. For example, **ResourceId.1** specifies the ID of the first instance and **ResourceId.2** specifies the ID of the second instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'maxItems' => 51, 'title' => '', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The object.'."\n", 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag associated with the instance.'."\n" ."\n" .'> * **N** specifies the serial number of the tag. For example, **Tag.1.Key** specifies the key of the first tag and **Tag.2.Key** specifies the key of the second tag.'."\n" .'> * If the key of the tag does not exist, the key is automatically created.', 'type' => 'string', 'required' => true, 'example' => 'demokey', 'title' => ''], 'Value' => ['description' => 'The value of the tag associated with the instance.'."\n" ."\n" .'> **N** specifies the serial number of the tag. For example, **Tag.1.Value** specifies the value of the first tag and **Tag.2.Value** specifies the value of the second tag.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demovalue', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4BD4E308-A3D8-4CD1-98B3-0ADAEE38****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter number is exceed, Valid is 20.', 'description' => ''], ['errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Key or TagKey.n is not valid.', 'description' => ''], ['errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Value is not valid.', 'description' => ''], ['errorCode' => 'InvalidParameter.ResourceId', 'errorMessage' => 'The specified parameter ResourceId.n is not valid.', 'description' => ''], ['errorCode' => 'MissParameter.TagOrResourceId', 'errorMessage' => 'The parameter Tag.n or ResourceId.n is needed.', 'description' => 'The parameters Tag and ResourceId cannot all be empty. At least one of them is passed in.'], ['errorCode' => 'InvalidParameter.Scope', 'errorMessage' => 'The specified parameter Scope is not valid.', 'description' => ''], ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter number is exceed.', 'description' => ''], ['errorCode' => 'NumberExceed.CustomTags', 'errorMessage' => 'The Custom Tags parameter number is exceed. Valid is 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' => ''], ['errorCode' => 'OperationDenied.QuotaExceed', 'errorMessage' => 'The Tags parameter number is exceed. Valid is 20.', 'description' => ''], ], 404 => [ ['errorCode' => 'InvalidDbInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4BD4E308-A3D8-4CD1-98B3-0ADAEE38****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 4BD4E308-A3D8-4CD1-98B3-0ADAEE38****\\r\\n","errorExample":""}]', 'title' => 'TagResources', 'description' => 'If you have a large number of instances, you can create multiple tags and add these tags to the instances. Then, you can filter instances by tag.'."\n" ."\n" .'* A tag consists of a key and a value. Each key must be unique in a region for an Alibaba Cloud account. Different keys can be mapped to the same value.'."\n" .'* If the tag that you specify does not exist, this tag is automatically created and added to the specified instance.'."\n" .'* If the key of the specified tag is the same as that of an existing tag, the specified tag overwrites the existing tag.'."\n" .'* You can add up to 20 tags to each instance.'."\n" .'* You can add tags to up to 50 instances in each request.'."\n" ."\n" .'You can also add tags to instances in the Tair (Redis OSS-compatible) console. For more information, see [Create a tag](~~118779~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:TagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'TransformInstanceChargeType' => [ 'summary' => 'Changes the billing method for a Tair instance between subscription and pay-as-you-go.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '56525', 'abilityTreeNodes' => ['FEATUREkvstoreSIWMD9'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. You can call the [DescribeInstances](~~473778~~) operation to query instance IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The subscription duration, in months. Valid values: **1** to **9**, **12**, **24**, and **36**.'."\n" ."\n" .'> This parameter is available and required only when the **ChargeType** parameter is set to **PrePaid**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" ."\n" .'- **true**: Automatic payment. This is the default value.'."\n" ."\n" .'- **false**: Manual payment. In the console, choose **Billing Management** > **Renewal Management** in the top navigation bar. In the navigation pane on the left, click **Or\\*\\*rs** > **My Or\\*\\*rs** to find and pay for the or\\*er.', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => 'true', 'title' => ''], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The target billing method. Valid values:'."\n" ."\n" .'- **PrePaid**: subscription. If you set this parameter to this value, you must also specify the **Period** parameter.'."\n" ."\n" .'- **PostPaid**: pay-as-you-go.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'default' => '', 'enum' => ['PostPaid', 'PrePaid', 'POSTPAID', 'PREPAID', 'PREPAY', 'POSTPAY'], 'example' => 'PrePaid', 'title' => '', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'- **true**: Auto-renewal is enabled.'."\n" ."\n" .'- **false** (default): Auto-renewal is disabled.', 'enumValueTitles' => ['false' => '', 'true' => ''], 'type' => 'string', 'default' => 'false', 'enum' => ['true', 'false'], 'required' => false, 'example' => 'false', 'title' => '', ], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => ['description' => 'The auto-renewal period, in months. Valid values: **1**, **2**, **3**, **6**, and **12**.'."\n" ."\n" .'> This parameter is required when the **AutoRenew** parameter is set to **true**.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => ['description' => 'The coupon ID.', 'type' => 'string', 'required' => false, 'default' => 'default', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => 'The expiration time of the instance.'."\n" ."\n" .'> This parameter is returned only when you change the billing method of an instance from pay-as-you-go to subscription.', 'type' => 'string', 'example' => '2021-05-13T00:00:00Z', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '82C791FB-8979-489E-853D-706D7743****', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '20881824000****', 'title' => ''], ], 'description' => 'The response parameters.', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', 'description' => ''], ['errorCode' => 'InvalidParam', 'errorMessage' => 'Period is invalid', 'description' => ''], ['errorCode' => 'ResourceNotAvailable', 'errorMessage' => 'Resource you requested is not available for finance user.', 'description' => ''], ['errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account does not have enough balance.', 'description' => ''], ['errorCode' => 'Order.LatestOrderIsHanding', 'errorMessage' => 'Latest order is handing, please retry later.', 'description' => ''], ], 403 => [ ['errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'Your account has not passed the real-name authentication yet.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-05-13T00:00:00Z\\",\\n \\"RequestId\\": \\"82C791FB-8979-489E-853D-706D7743****\\",\\n \\"OrderId\\": \\"20881824000****\\"\\n}","type":"json"}]', 'title' => 'TransformInstanceChargeType', 'description' => 'Before you call this operation, ensure you understand the billing implications and usage notes. For more information, see:'."\n" ."\n" .'- [Change a pay-as-you-go instance to subscription](~~54542~~).'."\n" ."\n" .'- [Change a subscription instance to pay-as-you-go](~~211549~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2026-01-14T10:29:12.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-21T08:46:02.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransformInstanceChargeType'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:TransformInstanceChargeType', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'TransformToEcs' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '219593', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => ['description' => 'The instance type of the target cloud-native instance. For more information, see [Instance types](~~26350~~).'."\n" ."\n" .'> If you want to convert a cluster instance, you must specify the corresponding cloud-native cluster instance type that includes .with.proxy in its name and specify the ShardCount parameter.'."\n" .'>'."\n" .'> - For a cluster instance, you must provide the corresponding cloud-native cluster specification that includes `.proxy`. You must also specify the number of shards by using the `ShardCount` parameter.', 'type' => 'string', 'required' => true, 'example' => 'tair.rdb.1g'."\n" .'tair.rdb.with.proxy.1g', 'title' => ''], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the target instance. Valid values:'."\n" ."\n" .'- **PostPaid**: pay-as-you-go'."\n" ."\n" .'- **PrePaid**: subscription. If you set this parameter to PrePaid, you must also specify the **Period** parameter.', 'type' => 'string', 'required' => false, 'default' => 'PostPaid', 'enum' => ['PrePaid', 'PostPaid'], 'example' => 'PostPaid', 'title' => '', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The subscription duration. Unit: month. Valid values: **1**, **2**, **3**, **4**, **5**, 6, 7, 8, 9, 12, 24, and 36.'."\n" ."\n" .'> This parameter is available and required only if you set the **ChargeType** parameter to **PrePaid**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ShardCount', 'in' => 'query', 'schema' => ['description' => 'The number of data shards in the cloud-native cluster instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the classic instance that you want to convert.', 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The Redis-compatible version of the instance. Valid values: **5.0**, **6.0**, and **7.0**.', 'type' => 'string', 'required' => true, 'enum' => ['5.0', '6.0', '7.0'], 'example' => '5.0', 'title' => '', ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when to switch the database after data migration. Valid values:'."\n" ."\n" .'- **Immediately**: The database is immediately switched after the migration is complete.'."\n" ."\n" .'- **MaintainTime**: The database is switched within the maintenance window.'."\n" ."\n" .'> Default value: **Immediately**.', 'type' => 'string', 'default' => 'Immediately', 'enum' => ['Immediately', 'MaintainTime'], 'required' => false, 'example' => 'Immediately', 'title' => '', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" ."\n" .'- **true**: enables auto-renewal.'."\n" ."\n" .'- **false**: disables auto-renewal.', 'type' => 'string', 'enum' => ['true', 'false'], 'required' => false, 'example' => 'false', 'title' => '', ], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The auto-renewal cycle. Unit: month. Valid values: **1**, **2**, **3**, **6**, and **12**.'."\n" ."\n" .'> This parameter is required if you set **AutoRenew** to **true**.', 'type' => 'integer', 'format' => 'int64', 'enum' => ['1', '2', '3', '6', '12'], 'required' => false, 'example' => '1', 'title' => '', ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n" ."\n" .'- **true**: performs a dry run to check the request. The check items include the required parameters, request format, service limits, and available resources. If the check fails, the corresponding error is returned. If the check passes, the `DryRunOperation` error code is returned.'."\n" ."\n" .'- **false** (default): sends a normal request and creates an instance after the request passes the check.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'IsAcrossZone', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to deploy the instance across availability zones. This feature is supported only for cluster instances.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'example' => ''], ], [ 'name' => 'IzNo', 'in' => 'query', 'schema' => ['description' => 'The ID of the availability zone.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'SecondaryIzNo', 'in' => 'query', 'schema' => ['description' => 'The ID of the secondary availability zone.', 'type' => 'string', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'DAABAD9B-890F-56C0-806C-6144946594AB'], 'OrderId' => ['description' => 'The ID of the order.', 'type' => 'string', 'example' => '20905403119****', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'TransformToEcs', 'summary' => 'Converts an instance that uses local disk to a cloud-native instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransformToEcs'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:TransformToEcs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DAABAD9B-890F-56C0-806C-6144946594AB\\",\\n \\"OrderId\\": \\"20905403119****\\"\\n}","type":"json"}]', ], 'TransformToPrePaid' => [ 'summary' => 'Converts a pay-as-you-go ApsaraDB for Tair (Redis-compatible) instance to the subscription billing method.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '56526', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstoreZ21KYW', 'FEATUREkvstoreDER7E8', 'FEATUREkvstore4XSUU7'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. You can call the [DescribeInstances](~~473778~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The subscription duration. Unit: months. Valid values: **1**, **2**, **3**, **4**, **5**, **6**, **7**, **8**, **9**, **12**, **24**, and **36**.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12', 'title' => ''], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-payment. Valid values:'."\n" ."\n" .'- **true**: Automatically completes the payment.'."\n" ."\n" .'- **false** (default): An order is generated, but is not automatically paid. You must then log on to the console to pay for the *order*. For more information, see [Manually renew an instance](~~26352~~).', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => 'true', 'title' => ''], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'- **true**: Auto-renewal is enabled.'."\n" ."\n" .'- **false**: Auto-renewal is disabled.', 'type' => 'string', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The auto-renewal period. Unit: months. Valid values: **1**, **2**, **3**, **6**, and **12**.'."\n" ."\n" .'> This parameter is required if **AutoRenew** is set to **true**.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'enum' => ['1'], 'required' => false, 'example' => '3', 'title' => '', ], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => ['description' => 'The coupon code.', 'type' => 'string', 'required' => false, 'default' => 'default', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => 'The expiration time of the instance\'s new subscription.', 'type' => 'string', 'example' => '2019-01-18T16:00:00Z', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '426F1356-B6EF-4DAD-A1C3-DE53B9DAF586', 'title' => ''], 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '111111111111111', 'title' => ''], ], 'description' => 'The response object.', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', 'description' => ''], ['errorCode' => 'InvalidParam', 'errorMessage' => 'Period is invalid', 'description' => ''], ['errorCode' => 'ResourceNotAvailable', 'errorMessage' => 'Resource you requested is not available for finance user.', 'description' => ''], ['errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account does not have enough balance.', 'description' => ''], ['errorCode' => 'Order.LatestOrderIsHanding', 'errorMessage' => 'Latest order is handing, please retry later.', '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' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2019-01-18T16:00:00Z\\",\\n \\"RequestId\\": \\"426F1356-B6EF-4DAD-A1C3-DE53B9DAF586\\",\\n \\"OrderId\\": \\"111111111111111\\"\\n}","type":"json"}]', 'title' => 'TransformToPrePaid', 'description' => 'To perform the equivalent operation in the console, see [Change the billing method to subscription](~~54542~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2026-01-14T10:29:12.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-09-09T12:53:42.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransformToPrePaid'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:TransformToPrePaid', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'UnlockDBInstanceWrite' => [ 'summary' => 'Unlocks a write-locked instance. After the instance is unlocked, you can read and write data to and from the instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192855', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****'], 'DBInstanceName' => ['description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'r-2ev03avw0r0552***', 'title' => ''], 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10****', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\",\\n \\"DBInstanceName\\": \\"r-2ev03avw0r0552***\\",\\n \\"TaskId\\": 0\\n}","type":"json"}]', 'title' => 'UnlockDBInstanceWrite', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockDBInstanceWrite'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:UnlockDBInstanceWrite', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UntagResources' => [ 'summary' => 'Removes tags from Tair (Redis OSS-compatible) instances.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => 'The resource type. Set the value to **INSTANCE**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', 'enum' => ['INSTANCE', 'instance'], 'title' => '', ], ], [ 'name' => 'All', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to remove all tags from the instance. Valid values:'."\n" ."\n" .'* **true**: removes all tags from the instance.'."\n" .'* **false** (default): does not remove all tags from the instance.'."\n" ."\n" .'> If you specify both this parameter and the **TagKey.N** parameter, this parameter does not take effect.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The IDs of the instances.'."\n", 'type' => 'array', 'items' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'title' => ''], 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'maxItems' => 51, 'title' => '', ], ], [ 'name' => 'TagKey', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The list of tag keys.'."\n", 'type' => 'array', 'items' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'demokey', 'title' => ''], 'required' => false, 'example' => 'demokey', 'maxItems' => 21, 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '601B6F25-21E7-4484-99D5-3EF2625C****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Key or TagKey.n is not valid.', 'description' => ''], ['errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Value is not valid.', 'description' => ''], ['errorCode' => 'InvalidParameter.ResourceId', 'errorMessage' => 'The specified parameter ResourceId.n is not valid.', 'description' => ''], ['errorCode' => 'MissParameter.TagOrResourceId', 'errorMessage' => 'The parameter Tag.n or ResourceId.n is needed.', 'description' => 'The parameters Tag and ResourceId cannot all be empty. At least one of them is passed in.'], ['errorCode' => 'InvalidParameter.Scope', 'errorMessage' => 'The specified parameter Scope is not valid.', 'description' => ''], ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter number is exceed.', 'description' => ''], ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter 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' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"601B6F25-21E7-4484-99D5-3EF2625C****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 601B6F25-21E7-4484-99D5-3EF2625C****\\r\\n","errorExample":""}]', 'title' => 'UntagResources', 'description' => '* You can remove up to 20 tags at a time.'."\n" .'* If a tag is removed from an instance and is not added to other instances, the tag is deleted.'."\n" ."\n" .'You can also remove tags from instances in the Tair (Redis OSS-compatible) console. For more information, see [Remove a tag](~~119157~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:UntagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], ], 'UpgradeProxy' => [ 'summary' => 'Updates the proxy node of a cluster instance to the latest version.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56529', 'abilityTreeNodes' => ['FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1vgja77wl7pb****', 'title' => ''], ], [ 'name' => 'ProxyInstanceIds', 'in' => 'query', 'schema' => ['description' => 'The IDs of the proxy nodes that you want to update. Separate multiple IDs with commas (,). This parameter is valid only for Redis Open-Source Edition classic instances.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'r-bp1vgja77wl7pb****-proxy-0', 'title' => ''], ], [ 'name' => 'SwitchTimeMode', 'in' => 'query', 'schema' => ['description' => 'The time to execute the specification change. Valid values:'."\n" ."\n" .'* **Immediately** (default): immediately executes the change.'."\n" .'* **MaintainTime**: executes the change during the maintenance window of the instance.'."\n" ."\n" .'> You can call the [ModifyInstanceMaintainTime](~~61000~~) operation to modify the maintenance window of an instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => 'Immediately', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B830CDBB-91D9-5571-B6F4-35C76266****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B830CDBB-91D9-5571-B6F4-35C76266****\\"\\n}","type":"json"}]', 'title' => 'UpgradeProxy', 'description' => 'The procedure and impacts for updating the minor version of an instance varies based on the instance architecture. For more information, see [Update the minor version of an instance](~~56450~~).'."\n" ."\n" .'> '."\n" ."\n" .'* Before you call this operation, you can call the [DescribeEngineVersion](~~473781~~) operation to query the current minor version of the proxy node.'."\n" ."\n" .'* The connection to the instance is interrupted during the update. We recommend that perform an update during off-peak hours. Make sure your application can reconnect to the instance after the update. For more information, see [Minor version update](~~56450~~).'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeProxy'], ], 'product' => ['code' => 'kvstore', 'title' => '云数据库 Redis 版'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:UpgradeProxy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], ], 'endpoints' => [ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.aliyuncs.com', 'endpoint' => 'r-kvstore.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-wulanchabu.aliyuncs.com'], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.cn-beijing.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-beijing.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-beijing.aliyuncs.com'], ['regionId' => 'cn-zhengzhou-jva', 'regionName' => 'Zhengzhou (China Unicom Joint Venture)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.cn-zhengzhou-jva.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-zhengzhou-jva.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-zhengzhou-jva.aliyuncs.com'], ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.cn-qingdao.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-qingdao.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-qingdao.aliyuncs.com'], ['regionId' => 'cn-wuhan-lr', 'regionName' => 'China (Wuhan - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.cn-wuhan-lr.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-wuhan-lr.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-wuhan-lr.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.aliyuncs.com', 'endpoint' => 'r-kvstore.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-shanghai.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.cn-hongkong.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-hongkong.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-hongkong.aliyuncs.com'], ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.aliyuncs.com', 'endpoint' => 'r-kvstore.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-heyuan.aliyuncs.com'], ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-zhangjiakou.aliyuncs.com'], ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.cn-shenzhen.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-shenzhen.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-shenzhen.aliyuncs.com'], ['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.cn-nanjing.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-nanjing.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-nanjing.aliyuncs.com'], ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.ap-northeast-2.aliyuncs.com', 'endpoint' => 'r-kvstore.ap-northeast-2.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.ap-northeast-2.aliyuncs.com'], ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.ap-northeast-1.aliyuncs.com', 'endpoint' => 'r-kvstore.ap-northeast-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.ap-northeast-1.aliyuncs.com'], ['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.cn-fuzhou.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-fuzhou.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-fuzhou.aliyuncs.com'], ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.cn-chengdu.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-chengdu.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-chengdu.aliyuncs.com'], ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.cn-guangzhou.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-guangzhou.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-guangzhou.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.ap-southeast-1.aliyuncs.com', 'endpoint' => 'r-kvstore.ap-southeast-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.ap-southeast-1.aliyuncs.com'], ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.ap-southeast-2.aliyuncs.com', 'endpoint' => 'r-kvstore.ap-southeast-2.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.ap-southeast-2.aliyuncs.com'], ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.ap-southeast-3.aliyuncs.com', 'endpoint' => 'r-kvstore.ap-southeast-3.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.ap-southeast-3.aliyuncs.com'], ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.cn-huhehaote.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-huhehaote.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-huhehaote.aliyuncs.com'], ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.ap-southeast-5.aliyuncs.com', 'endpoint' => 'r-kvstore.ap-southeast-5.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.ap-southeast-5.aliyuncs.com'], ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.ap-southeast-6.aliyuncs.com', 'endpoint' => 'r-kvstore.ap-southeast-6.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.ap-southeast-6.aliyuncs.com'], ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.ap-southeast-7.aliyuncs.com', 'endpoint' => 'r-kvstore.ap-southeast-7.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.ap-southeast-7.aliyuncs.com'], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'r-kvstore.aliyuncs.com', 'endpoint' => 'r-kvstore.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-hangzhou.aliyuncs.com'], ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'r-kvstore.us-east-1.aliyuncs.com', 'endpoint' => 'r-kvstore.us-east-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.us-east-1.aliyuncs.com'], ['regionId' => 'us-southeast-1', 'regionName' => 'US（Atlanta）', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'r-kvstore.us-southeast-1.aliyuncs.com', 'endpoint' => 'r-kvstore.us-southeast-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.us-southeast-1.aliyuncs.com'], ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'r-kvstore.eu-west-1.aliyuncs.com', 'endpoint' => 'r-kvstore.eu-west-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.eu-west-1.aliyuncs.com'], ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'r-kvstore.us-west-1.aliyuncs.com', 'endpoint' => 'r-kvstore.us-west-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.us-west-1.aliyuncs.com'], ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'r-kvstore.eu-central-1.aliyuncs.com', 'endpoint' => 'r-kvstore.eu-central-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.eu-central-1.aliyuncs.com'], ['regionId' => 'na-south-1', 'regionName' => 'Mexico', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'r-kvstore.na-south-1.aliyuncs.com', 'endpoint' => 'r-kvstore.na-south-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.na-south-1.aliyuncs.com'], ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'r-kvstore.me-east-1.aliyuncs.com', 'endpoint' => 'r-kvstore.me-east-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.me-east-1.aliyuncs.com'], ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'r-kvstore.me-central-1.aliyuncs.com', 'endpoint' => 'r-kvstore.me-central-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.me-central-1.aliyuncs.com'], ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'r-kvstore.ap-south-1.aliyuncs.com', 'endpoint' => 'r-kvstore.ap-south-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.ap-south-1.aliyuncs.com'], ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'r-kvstore.aliyuncs.com', 'endpoint' => 'r-kvstore.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-hangzhou-finance.aliyuncs.com'], ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'r-kvstore.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-shenzhen-finance-1.aliyuncs.com'], ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'r-kvstore.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-beijing-finance-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-beijing-finance-1.aliyuncs.com'], ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'r-kvstore.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'r-kvstore.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'r-kvstore-vpc.cn-shanghai-finance-1.aliyuncs.com'], ], 'errorCodes' => [ ['code' => 'Abs.InvalidAccount.NotFound', 'message' => 'account is not found.', 'http_code' => 400, 'description' => 'The account does not exist.'], ['code' => 'AccountLimitExceeded', 'message' => 'The maximum number of accounts that can be created is exceeded.', 'http_code' => 403, 'description' => 'The maximum number of accounts that can be created has been exceeded'], ['code' => 'ACCOUNT_BOOK_INSUFFICENT_BALANCE', 'message' => 'Account book does not have enough balance.', 'http_code' => null, 'description' => 'Your account balance is insufficient. Add funds to your account.'], ['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' => 'Intra-group users are not allowed to purchase.'], ['code' => 'AllocateVpcIp.NotEnough', 'message' => 'Ip resourc+B108:B183e is not enoughIp resource is not enough', 'http_code' => null, 'description' => 'The number of allocated IP addresses from B108 to b183e is insufficient.'], ['code' => 'AlreadyPrePaid', 'message' => 'This instance is already prepaid', 'http_code' => null, 'description' => 'The instance has been changed into a subscription one.'], ['code' => 'ApiException', 'message' => 'Processing timed out or generated an internal error.', 'http_code' => 400, 'description' => 'Processing timed out or generated an internal error.'], ['code' => 'ApiInvokeTimeout', 'message' => 'The request timed out.', 'http_code' => 400, 'description' => 'The request timed out. Please try again later.'], ['code' => 'AtLeastOneNetTypeExists', 'message' => 'Current DB instance net type does not support this operation.', 'http_code' => 400, 'description' => 'The network type of the current instance does not support this operation'], ['code' => 'AUTH.RAM_AUTH_FAILED', 'message' => 'Authorization failed for sub account.', 'http_code' => null, 'description' => 'The permissions cannot be granted to the RAM user.'], ['code' => 'BackupJobExists', 'message' => 'A backup job already exists in the specified DB instance.', 'http_code' => 400, 'description' => 'The current instance has uncompleted backup tasks. Wait until the backup tasks are completed before initiating a backup request.'], ['code' => 'BackupTimesExceeded', 'message' => 'The maximum number of backups that can be created for an instance each day is exceeded.', 'http_code' => 400, 'description' => 'The daily backup time exceeds the upper limit.'], ['code' => 'Bid.NotMatch', 'message' => 'CallerBid and ownerId\'s bid is not match.', 'http_code' => null, 'description' => 'The specified CallerBid value and ownerId value do not match.'], ['code' => 'CanNotAcquireLock', 'message' => 'Can not acquire lock for this operation. Please try it later', 'http_code' => 403, 'description' => 'Can not acquire lock for this operation. Please try it later'."\n"], ['code' => 'CanNotChangeShardCountWhenModify', 'message' => 'The number of shards cannot be changed.', 'http_code' => 200, 'description' => 'The number of data shards cannot be changed when you change the configurations of the instance.'], ['code' => 'CanNotChangeShardCountWhenModify', 'message' => 'Can\'t change shard count when modify instance spec.', 'http_code' => 400, 'description' => 'The number of shards cannot be modified when the cloud disk cluster version instance is changed.'], ['code' => 'CAN_NOT_FIND_SUBSCRIPTION', 'message' => 'No ordering information found.', 'http_code' => 400, 'description' => 'No ordering information found.'], ['code' => 'ChargeTypeViolation', 'message' => 'The operation is not permitted due to charge type of the instance.', 'http_code' => null, 'description' => 'The operation is not supported by pay-as-you-go instances. Check the billing method of the instance.'], ['code' => 'CLIENT.ALREADY_BOUND_TO_REPLICA_ERROR', 'message' => 'Source InstanceId already bound to a replica.', 'http_code' => null, 'description' => 'A disaster recovery channel has already been added to the source instance.'], ['code' => 'CLIENT.CREATE_BACKUP_JOB_ERROR', 'message' => 'Create backup job error', 'http_code' => null, 'description' => 'Failed to create the backup task.'], ['code' => 'CLIENT.DST_INST_SAME_AS_SRC_INST', 'message' => 'Destination InstanceId is the same as source InstanceId.', 'http_code' => null, 'description' => 'The specified source and destination instances are the same.'], ['code' => 'CLIENT.GENERAL_ERROR', 'message' => 'BLS error.', 'http_code' => null, 'description' => 'An error has occurred on the disaster recovery system.'], ['code' => 'CLIENT.INSTANCE_ID_NOT_FOUND', 'message' => 'InstanceId not found', 'http_code' => null, 'description' => 'Failed to find the instance.'], ['code' => 'CLIENT.MISSING_REQUIRED_PARAM', 'message' => 'Missing required param.', 'http_code' => null, 'description' => 'The required parameter must be specified.'], ['code' => 'CLIENT.PRODUCT_TEMPLATE_NOT_FOUND', 'message' => 'Product\'s template not found.', 'http_code' => null, 'description' => 'Failed to find the product template.'], ['code' => 'CLIENT.UNPROCESSABLE_ENTITY', 'message' => 'Unprocessable Entity.', 'http_code' => null, 'description' => 'The request cannot processed.'], ['code' => 'CLIENT.UNSUPPORTED_ENGINE_TYPE', 'message' => 'Unsupported engine type.', 'http_code' => null, 'description' => 'The engine type is not supported.'], ['code' => 'CLIENT.UNSUPPORTED_PRODUCT', 'message' => 'Unsupported product.', 'http_code' => null, 'description' => 'The product is not supported.'], ['code' => 'CLIENT.WRONG_STATUS', 'message' => 'BLS Wrong status.', 'http_code' => null, 'description' => 'An error has occurred on the disaster recovery system.'], ['code' => 'CLIENT.WRONG_STATUS_STATUS', 'message' => 'Source instance\'s tatus does not support this operation.', 'http_code' => null, 'description' => 'The operation is not supported while the source instance is in the current state.'], ['code' => 'ClusterNotSupport', 'message' => 'The instance cluster does not support this operation.', 'http_code' => 400, 'description' => 'The cluster does not support this operation.'], ['code' => 'COMMODITY.INVALID_COMPONENT', 'message' => 'Component choosed is not valid', 'http_code' => null, 'description' => 'The specified instance component is invalid. Check the component.'], ['code' => 'CommodityVerifyFail', 'message' => 'Your account status check has failed', 'http_code' => null, 'description' => 'Failed to check the account status.'], ['code' => 'CreateOrder.Failed', 'message' => 'Create order failed.', 'http_code' => null, 'description' => 'Failed to create the order.'], ['code' => 'DefaultVpc.NotSupport', 'message' => 'The default vpc create is not support.', 'http_code' => null, 'description' => 'A default VPC cannot be created.'], ['code' => 'delete is not allowed', 'message' => 'temp instance is creating', 'http_code' => null, 'description' => 'The temporary instance is being created.'], ['code' => 'DirectNotSupportSslOperation', 'message' => 'cs direct do not support ssl operation.', 'http_code' => 400, 'description' => 'Classic cluster instances with directly connected addresses do not support TLS/SSL encryption'], ['code' => 'DirectTransNodeDoubleLevelError', 'message' => 'The direct custins tranfer node double target level error.', 'http_code' => 400, 'description' => 'When adjusting only the number of shards for directly connected instances and global multi-active instances, you need to specify 2 or 0.5 times the original number of shards.'], ['code' => 'DirectTransUpgradeMajorVersionNotSupport.Malformed', 'message' => 'Direct connection mode is not supported for upgrading engine versions.', 'http_code' => 400, 'description' => 'The error message returned because the instance uses the direct connection mode.'], ['code' => 'DryRunOperation', 'message' => 'Request validation has been passed with DryRun flag set.', 'http_code' => 400, 'description' => 'The request performs the pre-check operation and has passed the pre-check, and does not create an instance.'], ['code' => 'EngineVersion.NotSupportOnLocalDisk', 'message' => 'Local disk instance does not support this engine version.', 'http_code' => 400, 'description' => 'Classic version (local disk) instance does not support this database version'], ['code' => 'ExceedQuota', 'message' => 'Up to 15 queries can be run at the same time.', 'http_code' => 403, 'description' => 'The number of requests reached the upper limit. Each user account can run up to 15 queries at the same time.'], ['code' => 'Forbbiden.MinorVersion', 'message' => 'The operation is not permitted for current minor version.', 'http_code' => null, 'description' => 'The operation is not supported by this instance version.'], ['code' => 'Forbbiden.NotInvitedUser', 'message' => 'User not in the invitation list.', 'http_code' => null, 'description' => 'The account is invalid.'], ['code' => 'Forbbiden.SubUser', 'message' => 'The specified action is not available for you.', 'http_code' => null, 'description' => 'The user does not have the permissions to perform the operation.'], ['code' => 'Forbedden.NotSupportRAM', 'message' => 'This action does not support accessed by RAM mode.', 'http_code' => null, 'description' => 'RAM users are not allowed to perform the operation.'], ['code' => 'Forbidden.InstanceNotFound', 'message' => 'The specified Instance is not found', 'http_code' => null, 'description' => 'The instance cannot be found. Call the DescribeInstances operation to query the instances that belong to the account.'], ['code' => 'Forbidden.NotAdminUser', 'message' => 'User not authorized to operate on the specified API as you are not the administrator.', 'http_code' => null, 'description' => 'Your account is not an administrator account and does not have the permissions to call the API operation.'], ['code' => 'Forbidden.RAM', 'message' => 'User not authorized to operate on the specified resource', 'http_code' => null, 'description' => 'The RAM user does not have the permissions required to manage the specified resource. Grant permissions to the user and try again.'], ['code' => 'Forbidden.RiskControl', 'message' => 'This operation is forbidden by Aliyun Risk Control system.', 'http_code' => null, 'description' => 'The operation is denied by the Alibaba Cloud Risk Control system.'], ['code' => 'GdcInstanceNotSupport', 'message' => 'The gdc custins trans not support', 'http_code' => 400, 'description' => 'The error message returned because the instance does not support this operation.'], ['code' => 'GET_COMMODITY_FAILED', 'message' => 'Get commodity failed.', 'http_code' => null, 'description' => 'Failed to obtain the product information.'], ['code' => 'has another restore in progress', 'message' => 'has another restore in progress', 'http_code' => null, 'description' => 'Other operations are in progress.'], ['code' => 'HasDirectConnectionNotSupport', 'message' => 'The instance has direct connection does not support this operation.', 'http_code' => 400, 'description' => 'The error message returned because the instance uses the direct connection mode.'], ['code' => 'HasRenewChangeOrder', 'message' => 'This instance has a renewChange order.', 'http_code' => null, 'description' => 'An order for renewal and configuration change already exists.'], ['code' => 'IdempotentParameterMismatch', 'message' => 'Request uses a client token in a previous request but is not identical to that request.', 'http_code' => 400, 'description' => 'Idempotent check.'], ['code' => 'ILLEGAL_ARGUMENT', 'message' => 'commodityCode is blank.', 'http_code' => null, 'description' => 'The commodityCode parameter must be specified. The QueryCommodity field is used to query commodities and the QueryPrice field is used to query prices.'], ['code' => 'ILLEGAL_ARGUMENT', 'message' => 'The system security ip group cannot be modified.', 'http_code' => 400, 'description' => 'the system ip address whitelist with the hidden attribute cannot be modified.'], ['code' => 'IncorrectBackupSetState', 'message' => 'Current backup set state does not support operations.', 'http_code' => null, 'description' => 'The operation is not supported while the backup is in the current state.'], ['code' => 'IncorrectDBInstance.NotSupported', 'message' => 'This instance do not support log audit.', 'http_code' => 400, 'description' => 'This instance does not support audit log related services'], ['code' => 'IncorrectDBInstanceCharacterType', 'message' => 'Current DB Instance character type does not support this operation.', 'http_code' => 400, 'description' => 'The type of the current instance does not support this operation.'], ['code' => 'IncorrectDBInstanceLockMode', 'message' => 'Current DB instance lock mode does not support this operation.', 'http_code' => null, 'description' => 'The operation is not supported while the instance is being locked.'], ['code' => 'IncorrectDBInstanceState', 'message' => 'Current DB instance state does not support this operation.', 'http_code' => 403, 'description' => 'The operation cannot be performed until the instance is in the running state.'], ['code' => 'IncorrectDBInstanceType', 'message' => 'Current DB instance type does not support this operation.', 'http_code' => null, 'description' => 'The operation is not supported while the instance has the current category. Read-only instances can be cloned and backed up.'], ['code' => 'IncorrectDBState', 'message' => 'The instance status does not support this operation.', 'http_code' => 500, 'description' => 'The operation cannot be performed on the instance in the state.'], ['code' => 'IncorrectEngineVersion', 'message' => 'Current engine version does not support operations.', 'http_code' => 400, 'description' => 'The current Redis version does not support this operation. Please refer to the relevant documentation for this operation to understand the Redis version requirements for this operation.'], ['code' => 'IncorrectMinorVersion', 'message' => 'Current engine minor version does not support operations.', 'http_code' => 400, 'description' => 'The operation is not supported by the minor version of the instance. Update the instance to the latest minor version and try again.'], ['code' => 'IncorrectPassword', 'message' => 'The Password provided is not correct.', 'http_code' => null, 'description' => 'The specified password is incorrect.'], ['code' => 'IncorrectTargetMajorVersion', 'message' => 'Current target majorversion does not support this operation.', 'http_code' => 400, 'description' => 'the current operation does not support the specified target major version. make sure that the specified target major version is greater than the current major version of the instance.'], ['code' => 'INQUERY_ORDER_FEE_FAILED', 'message' => 'Query price error.', 'http_code' => null, 'description' => 'The inquiry failed.'], ['code' => 'instance id not existed or frozened', 'message' => 'instance id not existed or frozened', 'http_code' => null, 'description' => 'The instance does not exist or is locked.'], ['code' => 'instance snapshot settings not existed', 'message' => 'instance snapshot settings not existed', 'http_code' => null, 'description' => 'The snapshot is being created or already exists.'], ['code' => 'InstanceClassDoesNotChange', 'message' => 'The instance class does not change. Please select a new one.', 'http_code' => 400, 'description' => 'The instance specification has not changed. Please modify the post chong\'sh'], ['code' => 'InstanceOperationUnsupported', 'message' => 'This operation is not supported in the current instance.', 'http_code' => 400, 'description' => 'The current instance does not support this operation.'], ['code' => 'InstanceStatus.NotSupport', 'message' => 'Instance status does not support this operation.', 'http_code' => 400, 'description' => 'The error message returned because the operation is not supported while the instance is in the current state.'], ['code' => 'InstanceType.NotSupport', 'message' => 'Current instance type does not support this operation.', 'http_code' => 400, 'description' => 'The current instance type does not support this operation'], ['code' => 'InstanceType.NotValid', 'message' => 'Current instance type does not support this operation.', 'http_code' => null, 'description' => 'The operation is not supported while the instance has the current category. Read-only instances can be cloned and backed up.'], ['code' => 'InsufficientBalance', 'message' => 'Your account does not have enough balance.', 'http_code' => null, 'description' => 'Your account balance is insufficient. Add funds to your account and try again.'], ['code' => 'InsufficientResourceCapacity', 'message' => 'There is insufficient capacity available for the requested instance.', 'http_code' => null, 'description' => 'The requested instance does not have sufficient capacity.'], ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => null, 'description' => 'An unknown error has occurred while processing the request.'], ['code' => 'InternalFailure', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 400, 'description' => 'An error has occurred on the server. Please try again later.'], ['code' => 'InternalFailure', 'message' => 'The request processing has failed due to some unknown error, exception or failure', 'http_code' => 500, 'description' => 'An unknown error has occurred. Please try again later.'], ['code' => 'invalid begin hour', 'message' => 'invalid begin hour', 'http_code' => null, 'description' => 'The start time is invalid.'], ['code' => 'invalid end hour', 'message' => 'invalid end hour', 'http_code' => null, 'description' => 'The end time is invalid.'], ['code' => 'InvalidAccountName.Duplicate', 'message' => 'Specified AccountName already exists in this instance.', 'http_code' => 400, 'description' => 'The error message returned because the account already exists.'], ['code' => 'InvalidAction', 'message' => 'Specified action is not valid.', 'http_code' => null, 'description' => 'The specified operation is invalid.'], ['code' => 'InvalidAuthorization', 'message' => 'The Request is not authorization.', 'http_code' => 400, 'description' => 'The error message returned because the authorization is invalid.'], ['code' => 'InvalidBackupMethod.Format', 'message' => 'Specified backup method is not valid.', 'http_code' => null, 'description' => 'The specified backup method is invalid. Valid values: Logical and Physical. Default value: Physical. Logical backups are not supported for ApsaraDB for Redis instances in which no databases exist. SQL Server supports only physical backups.'], ['code' => 'InvalidBackupOASRetentionPeriod.Malformed', 'message' => 'Specified backup OAS retention period is not valid.', 'http_code' => null, 'description' => 'The specified OAS backup retention period is invalid. Backup data can be retained for 7 to 730 days.'], ['code' => 'InvalidBackupRetentionPeriod.Malformed', 'message' => 'Specified backup retention period is not valid.', 'http_code' => null, 'description' => 'The specified backup retention period is invalid. Backup data can be retained for 7 to 730 days.'], ['code' => 'InvalidBackupSet.NotMatched', 'message' => 'Specified backup set does not match instance.', 'http_code' => 400, 'description' => 'The specified backup set and instance do not match'], ['code' => 'InvalidBackupSetID.NotFound', 'message' => 'Specified backup set ID does not exist.', 'http_code' => null, 'description' => 'The specified backup ID does not exist. Call the DescribeBackups operation to query backup IDs when you want to clone an instance.'], ['code' => 'InvalidBackupType.Format', 'message' => 'Specified backup type is not valid.', 'http_code' => null, 'description' => 'The backup type is invalid. Valid values: Auto and FullBackup. Default value: Auto. If you set the backup type to Auto, ApsaraDB for Redis automatically performs a full data backup or incremental data backup. If you set the backup type to FullBackup, ApsaraDB for Redis performs a full data backup.'], ['code' => 'InvalidCapacity.NotFound', 'message' => 'The Capacity provided does not exist in our records.', 'http_code' => 404, 'description' => 'The specified storage specification does not exist.'], ['code' => 'InvalidClassicExpiredDays.Format', 'message' => 'The specified classicExpiredDays format is not valid.', 'http_code' => null, 'description' => 'The classicExpiredDays value is invalid. During network type switching, classic endpoints can be retained for 1 to 60 days and are retained for 7 days by default.'], ['code' => 'InvalidClusterInstance.NotFound', 'message' => 'Specified cluster instance does not exist.', 'http_code' => 400, 'description' => 'The specified cluster instance is not found.'], ['code' => 'InvalidComponent', 'message' => 'The specified component is not valid.', 'http_code' => 400, 'description' => 'The order contains an invalid commodity module component'], ['code' => 'InvalidConnectionString', 'message' => 'ConnectionString is invalid, valid regex: ^\\w+$', 'http_code' => 400, 'description' => 'The prefix of the endpoint is invalid. The prefix must start with a lowercase letter and can contain lowercase letters and digits. The prefix can be 8 to 40 characters in length.'], ['code' => 'InvalidConnectionString.Duplicate', 'message' => 'Specified connection string already exists in the Aliyun RDS.', 'http_code' => 400, 'description' => 'The error message returned because the endpoint already exists.'], ['code' => 'InvalidConnectionString.Format', 'message' => 'Specified connection string is not valid.', 'http_code' => 400, 'description' => 'The connection string is invalid. Use a different one.'], ['code' => 'InvalidConnectionString.NotFound', 'message' => 'The specified connection string or network type is not found.', 'http_code' => 400, 'description' => 'The specified connection address or network type cannot be found.'], ['code' => 'InvalidConnectionStringOrPort.Duplicate', 'message' => 'Specified connection string or port want to be modified is the same with current net type.', 'http_code' => 400, 'description' => 'The connection string or port already exists.'], ['code' => 'InvalidDB.NotFound', 'message' => 'Specified db does not exist or DB status does not support.', 'http_code' => null, 'description' => 'The database does not exist, or the operation is not supported while the database is in the current state.'], ['code' => 'InvalidDBInstance.Malformed', 'message' => 'The specified db instance is invalid.', 'http_code' => 400, 'description' => 'The number of instance IDs passed in exceeds the limit.'], ['code' => 'InvalidDBInstance.NotFound', 'message' => 'The specified DB instance is not found.', 'http_code' => null, 'description' => 'The instance cannot be found. Call the DescribeInstances operation to query the instances that belong to the account.'], ['code' => 'InvalidDBInstanceClass.NotFound', 'message' => 'Specified DB instance class is not found.', 'http_code' => null, 'description' => 'The instance type is invalid. Check the instance type.'], ['code' => 'InvalidDbInstanceId.NotFound', 'message' => 'Specified instance does not exist.', 'http_code' => 400, 'description' => 'The specified instance does not exist'], ['code' => 'InvalidDBInstanceName.Deleted', 'message' => 'The specified DB instance is deleted.', 'http_code' => null, 'description' => 'The instance has been deleted.'], ['code' => 'InvalidDns.Conflict', 'message' => 'ParamsError.DnsConflict', 'http_code' => 400, 'description' => 'The DNS connection string already exists.'], ['code' => 'InvalidEndTime.Format', 'message' => 'Specified end time is not valid.', 'http_code' => 400, 'description' => 'The incoming end time does not meet the specification.'], ['code' => 'InvalidEndTime.Malformed', 'message' => 'The Specified parameter EndTime is not valid.', 'http_code' => null, 'description' => 'The end time is invalid. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Example: 2011-06-11T16:00Z.'], ['code' => 'InvalidEndTime.Malformed', 'message' => 'The specified parameter EndTime is invalid.', 'http_code' => 400, 'description' => 'The format of the end time is invalid. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Example: 2019-01-01T12:10Z.'], ['code' => 'InvalidEngineVersion.Format', 'message' => 'Current EngineVersion does not support operations.', 'http_code' => 400, 'description' => 'The operation is not supported while the instance runs this engine version.'], ['code' => 'InvalidEngineVersion.Malformed', 'message' => 'Specified engine version is not valid.', 'http_code' => 400, 'description' => 'The error message returned because the instance engine version is invalid.'], ['code' => 'InvalidInput', 'message' => 'The specified parameter is not valid.', 'http_code' => 400, 'description' => 'The specified instance type parameter is invalid.'], ['code' => 'InvalidInquiryPriceParamFault', 'message' => 'The request not refer to the correct order price param. please contact customer service.', 'http_code' => null, 'description' => 'The order price is incorrect. Submit a ticket.'], ['code' => 'InvalidInstance', 'message' => 'Unable to modify or transfer instance r-uf6yprpva6zjdubwza to cluster: ECS cluster DbInstance does not support SecurityGroup', 'http_code' => 500, 'description' => 'The operation is invalid.'], ['code' => 'InvalidInstanceId', 'message' => 'DBInstanceIdentifier does not refer to an existing DB instance.', 'http_code' => 400, 'description' => 'The specified instance ID cannot correspond to any instance.'], ['code' => 'InvalidInstanceId.NotFound', 'message' => 'The InstanceId provided does not exist in our records.', 'http_code' => 400, 'description' => 'The instance does not exist in our record. You can call the DescribeInstances interface to view the instance information under the current user.'], ['code' => 'InvalidInstanceId.NotFound', 'message' => 'The InstanceId provided does not exist in our records', 'http_code' => 400, 'description' => 'The instance ID does not exist.'], ['code' => 'InvalidInstanceId.NotFound', 'message' => 'The InstanceId provided does not exist in our records .', 'http_code' => 400, 'description' => 'The instance does not exist in our record. You can call the DescribeInstances interface to view the instance information under the current user.'], ['code' => 'InvalidInstanceIds.Malformed', 'message' => 'The Specified parameter "InstanceIds" is not valid.', 'http_code' => null, 'description' => 'The InstanceIds value is invalid.'], ['code' => 'InvalidInstanceName.Malformed', 'message' => 'The Specified parameter "InstanceName" is not valid.', 'http_code' => null, 'description' => 'The instance name is invalid.'], ['code' => 'InvalidInstances.Format', 'message' => 'The Specified parameter Instances is not valid.', 'http_code' => 400, 'description' => 'The Instances parameter passed in is invalid'], ['code' => 'InvalidInstances.Malformed', 'message' => 'The Specified parameter "Instances" is not valid.', 'http_code' => 400, 'description' => 'The Instances parameter passed in is invalid.'], ['code' => 'InvalidKey.Malformed', 'message' => 'Specified key is not valid.', 'http_code' => null, 'description' => 'The key is invalid.'], ['code' => 'InvalidOrderCharge.NotSupport', 'message' => 'The specified order charge does not support this operation.', 'http_code' => 400, 'description' => 'The billing type of the specified instance is not supported.'], ['code' => 'InvalidParam', 'message' => 'Period is invalid', 'http_code' => null, 'description' => 'The specified subscription duration is invalid.'], ['code' => 'InvalidParameter', 'message' => 'The specified parameter "InstanceName" is not valid.', 'http_code' => null, 'description' => 'The instance name is invalid.'], ['code' => 'InvalidParameter.Scope', 'message' => 'The specified Scope is invalid.', 'http_code' => 400, 'description' => 'The specified scope is invalid.'], ['code' => 'InvalidParameterCombination', 'message' => 'The end time must be greater than the start time.', 'http_code' => null, 'description' => 'The end time must be later than the start time. For example, you can set the start time to 2011-05-30 T12:11:20Z and set the end time to 2011-06-08 T12:09:20Z.'], ['code' => 'InvalidParameterCombination', 'message' => 'The end time must be greater than the start time', 'http_code' => 400, 'description' => 'The end time must be later than the start time.'], ['code' => 'InvalidParameters.Format', 'message' => 'Specified parameters is not valid.', 'http_code' => 400, 'description' => 'The parameter is invalid.'], ['code' => 'InvalidPassword.Malformed', 'message' => 'The Specified parameter "NewPassword" is not valid.', 'http_code' => 400, 'description' => 'Specified NewPassword parameters do not meet specification requirements'], ['code' => 'InvalidPassword.Malformed', 'message' => 'The Specified parameter "Password" is not valid.', 'http_code' => 400, 'description' => 'The specified Password parameters do not meet the requirements'], ['code' => 'InvalidPasswordFreeWhiteListCIDR', 'message' => 'Specified cidr 0.0.0.0/0 is forbidden when set password free.', 'http_code' => null, 'description' => 'The 0.0.0.0 IP address is included in a whitelist of an instance when password-free access within a VPC is being enabled for the instance.'], ['code' => 'InvalidPreferredBackupPeriod.Malformed', 'message' => 'Specified backup period is not valid.', 'http_code' => null, 'description' => 'The backup cycle is invalid. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday.'], ['code' => 'InvalidPreferredBackupTime', 'message' => 'Specified preferred backup time is not valid(HH:mmZ-HH:mmZ and one hour interval).', 'http_code' => 400, 'description' => 'When you modify a backup policy setting, the specified new backup time is invalid. The parameter PreferredBackupTime means that the backup time format is HH:mmZ-HH:mmZ(UTC time), and the backup time must be on the hour, and the interval time is 1 hour.'."\n" ."\n"], ['code' => 'InvalidPreferredBackupTime.Format', 'message' => 'Specified preferred backup time is not valid.', 'http_code' => null, 'description' => 'The backup time is invalid.'], ['code' => 'InvalidPricePlan.NotFound', 'message' => 'The price plan tree does not refer to the account', 'http_code' => null, 'description' => 'The price plan is not applicable to the account.'], ['code' => 'InvalidPricePlanResult.NotFound', 'message' => 'The price plan result does not refer to the account.', 'http_code' => null, 'description' => 'An error has occurred while performing a price inquiry. Submit a ticket.'], ['code' => 'InvalidPriceTaxingFault', 'message' => 'The taxing price is not correct. please contact customer service.', 'http_code' => null, 'description' => 'An error has occurred while performing a price inquiry. Submit a ticket.'], ['code' => 'InvalidReginAvzNotFound', 'message' => 'Specified user does not find the region and avz.', 'http_code' => 400, 'description' => 'Unable to find the corresponding zone'], ['code' => 'InvalidRegion.Format', 'message' => 'Specified Region is not valid.', 'http_code' => 400, 'description' => 'The specified region is invalid.'], ['code' => 'InvalidRegion.NotFound', 'message' => 'The RegionId or ZoneId provided does not exist in our records.', 'http_code' => null, 'description' => 'The specified region ID or zone ID does not exist in the records. Call the DescribeRegions operation to query the most recent region or zone list.'], ['code' => 'InvalidRenewalDuration.Format', 'message' => 'The specified duration does not valid.', 'http_code' => 400, 'description' => 'The specified auto-renewal duration is invalid.'], ['code' => 'InvalidRestoreTime', 'message' => 'Specified restore time must be later than the time point of opening backup log.', 'http_code' => 400, 'description' => 'The error message returned because the amount of time reserved to restore data is less than that is consumed to enable backup.'], ['code' => 'InvalidSearchTimeRange', 'message' => 'search time range cannot be longer than a day.', 'http_code' => 400, 'description' => 'The specified query time range is invalid.'], ['code' => 'InvalidSecurityGroup.NotFound', 'message' => 'Specified GlobalSecurityGroupIds is not valid.', 'http_code' => 400, 'description' => 'The specified security group ID is invalid. The instance failed to associate with the security group because the security group does not exist or is not in the same region as the instance.'], ['code' => 'InvalidSecurityIPList.Duplicate', 'message' => 'The SecurityIPList duplicated', 'http_code' => 400, 'description' => 'The IP address has already been used.'], ['code' => 'InvalidSecurityIPList.Format', 'message' => 'Specified security IP list format is not valid.', 'http_code' => null, 'description' => 'The specified secure IP addresses are invalid.'], ['code' => 'InvalidSecurityIPList.NotFound', 'message' => 'Specified same security IP does not exist or at least one security IP need.', 'http_code' => 404, 'description' => 'The same IP as the specified IP was not found in the whitelist group, or no IP was passed in.'], ['code' => 'InvalidSecurityIPList.QuotaExceeded', 'message' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'http_code' => 400, 'description' => 'The number of IP addresses in the list exceeds the limit'], ['code' => 'InvalidShardCountforYaochiPhysicalMaotaiEcs', 'message' => 'Failed to get shard count for YaochiPhysicalMaotaiEcs instance class.', 'http_code' => 400, 'description' => 'Shard information not found'], ['code' => 'InvalidStartTime.Format', 'message' => 'Specified start time is not valid.', 'http_code' => 400, 'description' => 'The incoming start time does not meet the specification requirements'], ['code' => 'InvalidStartTime.Malformed', 'message' => 'The specified parameter StartTime is invalid. The correct UTC format is yyyy-MM-ddTHH:mmZ.', 'http_code' => 400, 'description' => 'The format of the start time is invalid. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Example: 2019-01-01T12:10Z.'], ['code' => 'InvalidStartTime.Malformed', 'message' => 'Failed to verify the specified parameter StartTime. The correct UTC format is yyyy-MM-ddTHH:mmZ.', 'http_code' => 400, 'description' => 'The format of the end time is invalid. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Example: 2019-01-01T12:10Z.'], ['code' => 'InvalidStartTimeAndEndTime.Malformed', 'message' => 'The end time must be greater than the start time.', 'http_code' => 400, 'description' => 'The end time must be later than the start time.'], ['code' => 'InvalidStatus', 'message' => 'Specified instance status is Modifying.', 'http_code' => 400, 'description' => 'Specified instance status is Modifying.'], ['code' => 'InvalidStatus.NotFound', 'message' => 'The Status provided does not exist in our records.', 'http_code' => null, 'description' => 'The operation is not supported while the instance is in the current state.'], ['code' => 'InvalidTagValue.Malformed', 'message' => 'The specified Tag.n.Value is invalid. This parameter must be 0 to 128 characters in length and can contain Unicode letters, spaces, numbers, pluses (+), hyphens (-), equal signs (=), periods (.), underscores (_), colons (:), and forward slashes (/).', 'http_code' => 400, 'description' => 'The format of the tag value is invalid. The tag value can be 0 to 128 characters in length and can contain letters, spaces, digits, and special characters. Special characters include + - = . _ : /'], ['code' => 'InvalidToken.Malformed', 'message' => 'The Specified parameter "Token" is not valid.', 'http_code' => null, 'description' => 'An error has occurred while authenticating the token.'], ['code' => 'InvalidUser.NotFound', 'message' => 'Specified user does not exist.', 'http_code' => null, 'description' => 'The specified account does not exist.'], ['code' => 'InvalidVPCId.NotFound', 'message' => 'Specified virtual vpc is not found.', 'http_code' => 400, 'description' => 'The specified VPC is not found. Check whether the VPC ID is correct.'], ['code' => 'InvalidVpcParameter', 'message' => 'Specified VPC parameter is not valid.', 'http_code' => 400, 'description' => 'the specified vpc parameter is invalid.'], ['code' => 'InvalidvSwitchId', 'message' => 'The Specified vSwitchId zone not supported.', 'http_code' => 400, 'description' => 'The specified vswitch is not supported in this Availability Zone'], ['code' => 'InvalidVSwitchId.Mismatch', 'message' => 'The Specified vSwitchId does not matched vpc.', 'http_code' => 400, 'description' => 'The specified vSwitch does not belong to the specified VPC. Check the vSwitch settings.'], ['code' => 'InvalidZoneId.Format', 'message' => 'Specified ZoneId is not valid.', 'http_code' => 400, 'description' => 'The specified Availability Zone ID is invalid'], ['code' => 'InvalidZoneId.NotFound', 'message' => 'The ZoneId provided is invalid.', 'http_code' => null, 'description' => 'The specified zone ID is invalid. Call the DescribeRegions operation to query the most recent zone list.'], ['code' => 'IzNotSupportSwitchNetworkError', 'message' => 'Specify iz not support switch network.', 'http_code' => null, 'description' => 'The specified iz does not support network switching.'], ['code' => 'IzNotSupportVpcError', 'message' => 'Specify iz not support vpc.', 'http_code' => null, 'description' => 'The specified iz does not support VPCs.'], ['code' => 'LockTimeout', 'message' => 'The request processing has failed due to lock timeout.', 'http_code' => 400, 'description' => 'The current request conflicts with another request, please try again later.'], ['code' => 'LxCreateOrderFailed', 'message' => 'Lx create order faied', 'http_code' => null, 'description' => 'The Lingxiao system failed to create the order.'], ['code' => 'LX_CENTER_GET_COMMODITY_ERROR', 'message' => 'Get commodity from lx system error.', 'http_code' => 400, 'description' => 'The product information cannot be obtained because an error has occurred on the Lingxiao system.'], ['code' => 'MinorVersionNotSupport', 'message' => 'Custins minor version does not support current action.', 'http_code' => 500, 'description' => 'The error message returned because this operation is not supported for the current minor engine version.'], ['code' => 'missing bid', 'message' => 'missing bid', 'http_code' => null, 'description' => 'The bid parameter must be specified.'], ['code' => 'missing instance id', 'message' => 'missing instance id', 'http_code' => null, 'description' => 'The instance ID is not specified.'], ['code' => 'missing snapshot id', 'message' => 'missing snapshot id', 'http_code' => null, 'description' => 'The snapshot ID must be specified.'], ['code' => 'missing task id', 'message' => 'missing task id', 'http_code' => null, 'description' => 'The task ID must be specified.'], ['code' => 'missing temp instance id', 'message' => 'missing temp instance id', 'http_code' => null, 'description' => 'The temporary instance ID must be specified.'], ['code' => 'missing uid', 'message' => 'missing uid', 'http_code' => null, 'description' => 'The uid parameter is not specified.'], ['code' => 'MissingCapacity', 'message' => 'Capacity is mandatory for this action.', 'http_code' => null, 'description' => 'The Capacity parameter must be specified.'], ['code' => 'MissingClassCode', 'message' => 'Capacity or InstanceClass is mandatory for this action.', 'http_code' => 404, 'description' => 'Capacity or InstanceClass is a required parameter.'], ['code' => 'MissingParameter', 'message' => 'You must specify the parameter.', 'http_code' => 400, 'description' => 'The parameter must be specified.'], ['code' => 'MissingParameter', 'message' => 'You must specify OwnerId.', 'http_code' => 400, 'description' => 'The OwnerId parameter must be specified.'], ['code' => 'MissingParameter', 'message' => 'You must specify the parameter Period.', 'http_code' => 400, 'description' => 'The Period parameter must be specified.'], ['code' => 'MissingParameter', 'message' => 'You must specify the required parameter.', 'http_code' => 400, 'description' => 'The required parameter must be specified.'], ['code' => 'MissingParameter', 'message' => 'Either InstanceName or NewPassword must be specified.', 'http_code' => 400, 'description' => 'The instance name or password must be specified.'], ['code' => 'MissingParameter', 'message' => 'You must specify the parameter InstanceId.', 'http_code' => 400, 'description' => 'The instance ID must be specified.'], ['code' => 'MissingSwitchId', 'message' => 'VSwitchId is required for this operation.', 'http_code' => 400, 'description' => 'Specify VSwitchId.'], ['code' => 'MissParameter.TagOrResourceId', 'message' => 'The parameter Tag.n or ResourceId.n is needed.', 'http_code' => 400, 'description' => 'The parameters Tag and ResourceId cannot all be empty. At least one of them is passed in.'], ['code' => 'MODIFY_SYSTEM_SECURITY_IP_GROUP', 'message' => 'The system security ip group cannot be modified.', 'http_code' => 400, 'description' => 'system-generated ip address whitelist security group'], ['code' => 'NetTypeExists', 'message' => 'Specified net type already existed.', 'http_code' => 400, 'description' => 'The specified network type already exists'], ['code' => 'NetworkType.NotSupport', 'message' => 'Specified network type does not support this operation.', 'http_code' => 400, 'description' => 'The operation cannot be performed on an instance that has a public endpoint or a private endpoint. Release the endpoint and try again.'], ['code' => 'NewSSLAlreadyEnabled', 'message' => 'new SSL have already been enabled.', 'http_code' => 400, 'description' => 'The instance has the new SSL certificate enabled.'], ['code' => 'NotFoundOrder', 'message' => 'Order not found', 'http_code' => 404, 'description' => 'The error message returned because the order does not exist.'], ['code' => 'NumberExceed.CustomTags', 'message' => 'The maximum number of Custom Tags (20) is exceeded.', 'http_code' => 400, 'description' => 'The number of custom tags cannot exceed 20.'], ['code' => 'OnEcsInstance.NotSupport', 'message' => 'OnEcs Instance does not support this operation.', 'http_code' => 403, 'description' => 'The error message returned because the instance uses cloud disks.'], ['code' => 'OperationDenied.AccountStatus', 'message' => 'The operation is not permitted due to status of account.', 'http_code' => 403, 'description' => 'This operation is not allowed due to the state of the account.'], ['code' => 'ORDER.ACCOUNT_STATUS_ILLEGAL', 'message' => 'Current account status is illegal', 'http_code' => null, 'description' => 'Your account state is invalid.'], ['code' => 'ORDER.BID_USER_ORDER_FORBIDDEN', 'message' => 'Bid account is not allowed to do this action', 'http_code' => null, 'description' => 'The operation cannot be performed by using a BID account.'], ['code' => 'ORDER.INSTANCE_HAS_INACTIVE_CHANGE', 'message' => 'Current instance has inactive change action.', 'http_code' => null, 'description' => 'The instance has operations in progress.'], ['code' => 'ORDER.INST_HAS_UNPAID_ORDER', 'message' => 'Current instance has unpaid order.', 'http_code' => null, 'description' => 'Your account has unpaid orders for the instance.'], ['code' => 'ORDER.INST_HAS_UNSETTLED_BILLS', 'message' => 'Current instance has unsettled bills.', 'http_code' => null, 'description' => 'The account has unpaid orders for the instance.'], ['code' => 'ORDER.NOT_ENOUGH_ACTIVITY_STOCK', 'message' => 'Does not have enough activity stock.', 'http_code' => null, 'description' => 'Insufficient resources are available.'], ['code' => 'ORDER.ORDER_AMOUNT_ILLEGAL', 'message' => 'Current order\'s amount is illegal.', 'http_code' => null, 'description' => 'The order amount is invalid.'], ['code' => 'ORDER.PERIOD_INVALID', 'message' => 'Period to buy is not valid.', 'http_code' => null, 'description' => 'The specified subscription period is invalid.'], ['code' => 'ORDER.QUANTITY_INVALID', 'message' => 'Quantity to buy is not valid.', 'http_code' => null, 'description' => 'The specified purchase quantity is invalid.'], ['code' => 'ORDER.SYS_CONSTRAINT_INVALID', 'message' => 'System constrains faild.', 'http_code' => null, 'description' => 'The order system constraint is invalid.'], ['code' => 'ORD_S_QUERY_PROD_ERROR', 'message' => 'Error in querying ordering information.', 'http_code' => 400, 'description' => ''], ['code' => 'Param.NotFound', 'message' => 'Specified Param %s is not found.', 'http_code' => 400, 'description' => 'Missing necessary parameters'], ['code' => 'ParameterInvalid', 'message' => 'Too many queued queries', 'http_code' => 500, 'description' => 'The error message returned because the request is queued up. Try again later.'], ['code' => 'ParameterLeastAssociate', 'message' => 'Must input at least one optional parameter.', 'http_code' => null, 'description' => 'At least one optional parameter must be specified.'], ['code' => 'ParamNotAllowedModify', 'message' => 'Specified parameter is not allowed to be modify.', 'http_code' => 400, 'description' => 'The specified parameter cannot be modified'], ['code' => 'ParamNotSupportedForCurrentVersion', 'message' => 'Parameter is not supported for current version.', 'http_code' => 401, 'description' => 'The error message returned because modifications to parameter values are not supported for the current engine version.'], ['code' => 'PAY.ACCOUNT_BOOK_NOT_EXIST', 'message' => 'Pay failed for account book not exist.', 'http_code' => null, 'description' => 'The bill does not exist.'], ['code' => 'PAY.AMOUNT_LIMIT_EXCEEDED', 'message' => 'Pay failed for amount limit exceed.', 'http_code' => null, 'description' => 'The order amount exceeds the upper limit.'], ['code' => 'PAY.COUPON_NOT_EXIST', 'message' => 'Pay failed for coupon not exist.', 'http_code' => null, 'description' => 'The coupon does not exist.'], ['code' => 'PAY.COUPON_NOT_MEET_CONSUMPTION_RULE', 'message' => 'Pay failed for coupon not meet consumption rule.', 'http_code' => null, 'description' => 'The coupon does not meet consumption rules.'], ['code' => 'PAY.CURRENCY_INCONSISTENCY', 'message' => 'Pay failed for currency inconsistency.', 'http_code' => null, 'description' => 'The system does not support the currency with which you are attempting to pay for the order.'], ['code' => 'PAY.CURRENCY_NOT_SUPPORTED', 'message' => 'Pay failed for currency not supported.', 'http_code' => null, 'description' => 'The currency is not supported.'], ['code' => 'PAY.GET_PAY_URL_ERROR', 'message' => 'Pay failed for getting pay url error.', 'http_code' => null, 'description' => 'The payment URL is incorrect.'], ['code' => 'PAY.INSUFFICIENT_BALANCE', 'message' => 'User attempted to create a new order.but user account balance is insufficient.', 'http_code' => null, 'description' => 'You have insufficient balance in your account.'], ['code' => 'PAY.INVALID_AMOUNT', 'message' => 'Pay failed for invalid amount.', 'http_code' => null, 'description' => 'The order amount is invalid.'], ['code' => 'PAY.INVALID_CREDIT_CARD', 'message' => 'Pay failed for credit card invalid.', 'http_code' => null, 'description' => 'The credit card is invalid.'], ['code' => 'PAY.NO_CREDIT_CARD', 'message' => 'Pay failed for no credit card.', 'http_code' => null, 'description' => 'No credit cards are added to the account.'], ['code' => 'PAY.PAYMENT_PARAMETER_ INVALID', 'message' => 'Pay failed for payment parameter not failed.', 'http_code' => null, 'description' => 'The payment parameter has an invalid value.'], ['code' => 'PAY.PAY_ORDER_FAILED', 'message' => 'Pay order failed.', 'http_code' => null, 'description' => 'Failed to make the payment for the order.'], ['code' => 'PAY.QUERY_QUOTA_BOOK_FAILED', 'message' => 'Pay failed for querying quota book failed.', 'http_code' => null, 'description' => 'Failed to obtain the quota.'], ['code' => 'PAY.REFUND_FAILED', 'message' => 'Pay failed for refund failed.', 'http_code' => null, 'description' => 'An error has occurred while refunding.'], ['code' => 'PAY.STORED_CARD_NOT_EXIST', 'message' => 'Pay failed for stored card not exist.', 'http_code' => null, 'description' => 'The memory card does not exist.'], ['code' => 'PAY.TAX_CALC_FAILED', 'message' => 'Pay failed for tax calculate failed.', 'http_code' => null, 'description' => 'An error has occurred while performing tax calculation.'], ['code' => 'PAY.USER_DECLINED', 'message' => 'Pay failed for user has declined.', 'http_code' => null, 'description' => 'The order has been cancelled.'], ['code' => 'PAY.WITHHOLDING_AGREEMENT_ILLEGAL', 'message' => 'Pay failed for withholding agreement illagal.', 'http_code' => null, 'description' => 'Your account balance is insufficient to make the payment.'], ['code' => 'PaymentMethodNotFound', 'message' => 'No payment method has been registered on the account.', 'http_code' => null, 'description' => 'No payment methods are specified for your account.'], ['code' => 'PRICE.INQUIRY_FAILED', 'message' => 'Query price error.', 'http_code' => null, 'description' => 'Failed to obtain the price.'], ['code' => 'PRODUCT.INSUFFICIENT_STOCK', 'message' => 'Dose not have enough resource.', 'http_code' => null, 'description' => 'Insufficient resources are available.'], ['code' => 'PRODUCT.NOT_AVAILABLE_IZ', 'message' => 'Available iz is not valid.', 'http_code' => null, 'description' => 'The zone is invalid.'], ['code' => 'ProxyError', 'message' => 'Invoke backend proxy error.', 'http_code' => 500, 'description' => 'Agent execution error, please try again later.'."\n"], ['code' => 'PURCHASE.NO_VAILD_PURCHASE', 'message' => 'Dose not have valid purchase.', 'http_code' => null, 'description' => 'The purchase is invalid.'], ['code' => 'PURCHASE.PURCHASE_QUERY_FAILED', 'message' => 'Query purchase failed.', 'http_code' => null, 'description' => 'Failed to obtain the purchase record.'], ['code' => 'QUERY_PRICE_RESPONSE_ERROR', 'message' => 'Get price failed.', 'http_code' => null, 'description' => 'Failed to obtain the price.'], ['code' => 'QuotaExceed', 'message' => 'Living afterpay instances quota exceed.', 'http_code' => null, 'description' => 'The maximum number of instances has been reached.'], ['code' => 'QuotaExceed.AfterpayInstance', 'message' => 'Living afterpay instances quota exceeded.', 'http_code' => null, 'description' => 'The maximum number of instances has been reached.'], ['code' => 'QuotaNotEnough', 'message' => 'Quota not enough in this zone.', 'http_code' => null, 'description' => 'The number of instances specified for this region is insufficient.'], ['code' => 'RealNameAuthenticationError', 'message' => 'Your account has not passed the real-name authentication yet.', 'http_code' => null, 'description' => 'Your account has not completed real-name verification.'], ['code' => 'RegionNotSupportGdc', 'message' => 'This region does not support create global distribute cache.', 'http_code' => 400, 'description' => 'The specified region does not support creating a distributed (Global Distributed Cache) instance.'], ['code' => 'RequiredParam.NotFound', 'message' => 'Required input param is not found.', 'http_code' => 400, 'description' => 'Missing input parameter'], ['code' => 'ResourceGroupNotExist', 'message' => 'ResourceGroup does not exist.', 'http_code' => 400, 'description' => 'The specified resource group does not exist.'], ['code' => 'ResourceNotAvailable', 'message' => 'Resource you requested is not available for finance user.', 'http_code' => null, 'description' => 'The requested resource is unavailable to users of Alibaba Finance Cloud.'], ['code' => 'RISK.RISK_CONTROL_REJECTION', 'message' => 'Operation is rejected for risk control.', 'http_code' => null, 'description' => 'The operation has been disabled due to risk management.'], ['code' => 'SecurityGroup.NotSupported', 'message' => 'This region does not support security group.', 'http_code' => 400, 'description' => 'Security group-related operations are not supported in the current region.'], ['code' => 'SecurityIPList.Duplicate', 'message' => 'Specified same security IP already exists.', 'http_code' => 400, 'description' => 'The specified whitelist group already contains the same IP address.'], ['code' => 'SERVER.CLONE_INSTANCE_JOB_ERROR', 'message' => 'Clone instance job error.', 'http_code' => null, 'description' => 'Failed to clone the instance.'], ['code' => 'SERVER.CREATE_BACKUP_JOB_ERROR', 'message' => 'Create backup job error.', 'http_code' => null, 'description' => 'An error has occurred while creating the backup.'], ['code' => 'SERVER.INSTANCE_ID_NOT_FOUND', 'message' => 'Instance not found.', 'http_code' => null, 'description' => 'Failed to find the instance.'], ['code' => 'SERVER.PRODUCT_TEMPLATE_NOT_FOUND', 'message' => 'Product\'s profile template not found.', 'http_code' => null, 'description' => 'The product overview template cannot be found.'], ['code' => 'SERVER.WFE_ERROR', 'message' => 'Workflow engine error.', 'http_code' => null, 'description' => 'An error has occurred on the workflow engine.'], ['code' => 'ServiceNotSupported', 'message' => 'The specified service is not supported.', 'http_code' => null, 'description' => 'The specified service is not supported.'], ['code' => 'ServiceUnavailable', 'message' => 'The request has failed due to a temporary failure of the server.', 'http_code' => null, 'description' => 'A temporary error has occurred on the server while processing the request.'], ['code' => 'ServiceUnavailable', 'message' => 'The request has failed due to a temporary failure of the server', 'http_code' => 400, 'description' => 'A server error has occurred. Try again later. If the error persists, submit a ticket.'], ['code' => 'SignatureNonceUsed', 'message' => 'Specified signature nonce was used already.', 'http_code' => null, 'description' => 'The specified signature has been used.'], ['code' => 'snapshot id not existed', 'message' => 'snapshot id not existed', 'http_code' => null, 'description' => 'The snapshot ID does not exist.'], ['code' => 'snapshot is creating', 'message' => 'snapshot is creating', 'http_code' => null, 'description' => 'The snapshot is currently being created.'], ['code' => 'snapshot number exceed', 'message' => 'snapshot number exceed', 'http_code' => null, 'description' => 'The maximum number of snapshots has been reached.'], ['code' => 'Snapshot operation forbidden', 'message' => 'instance inactive or has another task doing', 'http_code' => null, 'description' => 'The instance has not been activated or another task is currently in progress.'], ['code' => 'SPEC_NOT_FOUND', 'message' => 'The module you purchased is illegal, please reselect.', 'http_code' => 400, 'description' => 'The purchased module is illegal, please re-select'], ['code' => 'SSLEnabledStateExistsFault', 'message' => 'The SSL Certificate of the instance has been enabled.', 'http_code' => 400, 'description' => 'SSL encryption is enabled for the instance.'], ['code' => 'SSLNotSupport', 'message' => 'old version custins does not support enable ssl.', 'http_code' => 400, 'description' => 'Older Redis instances do not support SSL/TLS encryption.'], ['code' => 'SSLNotSupportNetType', 'message' => 'SSL instance does not support create public network.', 'http_code' => 403, 'description' => 'SSL-enabled instances do not allow you to create public networks.'], ['code' => 'SYSTEM.SALE_VALIDATE_NO_SPECIFIC_CODE_FAILED', 'message' => 'The components you purchased is illegal.', 'http_code' => 400, 'description' => 'The module you purchased is illegal.'], ['code' => 'SYSTEM.SYSTEM_ERROR', 'message' => 'Lx system error.', 'http_code' => null, 'description' => 'A system error has occurred.'], ['code' => 'SYSTEM.UNKNOWN_ERROR', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => null, 'description' => 'An unknown error has occurred.'], ['code' => 'TargetMajorVersionNotSupport', 'message' => 'The target major version not supported to upgrade.', 'http_code' => 400, 'description' => 'Upgrading to this large Redis version is not supported'], ['code' => 'Task.Conflict', 'message' => 'Current instance has unfinished task(buy or modify spec).', 'http_code' => 400, 'description' => 'The current instance has an outstanding order task.'], ['code' => 'TaskHasExist', 'message' => 'The task already exists.', 'http_code' => 500, 'description' => 'The task already exists.'], ['code' => 'temp instance existed', 'message' => 'temp instance existed', 'http_code' => null, 'description' => 'The temporary instance already exists.'], ['code' => 'temp instance id not existed or frozened', 'message' => 'temp instance id not existed or frozened', 'http_code' => null, 'description' => 'The temporary instance does not exist or is locked.'], ['code' => 'temp instance not ready', 'message' => 'temp instance not ready', 'http_code' => null, 'description' => 'The temporary instance already exists.'], ['code' => 'Throttling.Api', 'message' => 'Request was denied due to api flow control.', 'http_code' => 400, 'description' => 'The request is throttled. Please try again later.'], ['code' => 'Throttling.User', 'message' => 'Request was denied due to user flow control.', 'http_code' => 403, 'description' => 'The error message returned because traffic throttling was triggered.'], ['code' => 'uid not existed', 'message' => 'uid not existed', 'http_code' => null, 'description' => 'The specified uid does not exist.'], ['code' => 'UnitCodeNotSupportAcrossRegion', 'message' => 'This unit is not allowed to cross unit.', 'http_code' => 500, 'description' => 'The current instance does not support migration in this region.'], ['code' => 'unknown', 'message' => 'An unknown error occurred.', 'http_code' => 500, 'description' => 'An unknown system error occurred. Try again later.'], ['code' => 'VpcAndVSwitchNotChange', 'message' => 'VpcId and vSwitchId not change.', 'http_code' => 400, 'description' => 'The VpcId and vSwitchId parameter values are not changed.'], ['code' => 'VPCERROR.NOT_ENABLED', 'message' => 'VPC is not enabled in this zone.', 'http_code' => null, 'description' => 'The VPC service is unavailable in the current region.'], ['code' => 'VpcFreePasswordNoSupport', 'message' => 'The custins opend VPCFreePassword not support this operation.', 'http_code' => 403, 'description' => 'This operation is not supported for the instance because the VPC secret exemption is enabled or the# no_loose_check-whitelist-always parameter is set to no at the same time.'], ['code' => 'VpcId is wrong.', 'message' => 'VpcId is wrong.', 'http_code' => 400, 'description' => 'The specified VPC ID is invalid.'], ['code' => 'VpcServiceError', 'message' => 'Failed to invoke the VPC service.', 'http_code' => 400, 'description' => 'Failed to call the VPC service.'], ['code' => 'VpcVerifyError', 'message' => 'VpcId is wrong.UnsupportedParameter.', 'http_code' => null, 'description' => 'The VPC ID is invalid.'], ['code' => 'Zone.Closed', 'message' => 'Specified zone is closed.', 'http_code' => 400, 'description' => 'The specified Availability Zone is closed'], ['code' => 'Zone.NotSupport', 'message' => 'Specified zone does not support creating with instance class.', 'http_code' => null, 'description' => 'The category of the instance is not supported by the specified region.'], ['code' => 'ZoneIdNotFound', 'message' => 'Specify iz not support switch network.', 'http_code' => 400, 'description' => 'Unable to find Availability Zone'], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2026-03-04T14:06:42.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'TransformInstanceChargeType'], ['description' => 'Request parameters changed', 'api' => 'TransformToPrePaid'], ], 'createdAt' => '2026-01-14T10:30:19.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeIntranetAttribute'], ], 'createdAt' => '2025-12-22T07:20:39.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'EnableAdditionalBandwidth'], ], 'createdAt' => '2025-12-12T02:46:55.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairKVCacheVNode'], ['description' => 'Response parameters changed', 'api' => 'DescribeTairKVCacheInferInstances'], ], 'createdAt' => '2025-12-04T14:08:10.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceAttribute'], ], 'createdAt' => '2025-11-12T11:09:17.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeGlobalSecurityIPGroup'], ], 'createdAt' => '2025-10-30T14:43:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'CreateAccount'], ], 'createdAt' => '2025-10-27T13:02:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'CreateGlobalDistributeCache'], ], 'createdAt' => '2025-05-30T06:19:52.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2025-05-19T08:44:00.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2025-05-19T05:35:41.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateBackup'], ['description' => 'Response parameters changed', 'api' => 'DescribeClusterBackupList'], ['description' => 'Response parameters changed', 'api' => 'DescribeBackups'], ['description' => 'Request parameters changed', 'api' => 'CreateBackup'], ['description' => 'Response parameters changed', 'api' => 'DescribeBackups'], ['description' => 'Response parameters changed', 'api' => 'DescribeClusterBackupList'], ], 'createdAt' => '2025-04-22T09:37:19.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeHistoryTasks'], ], 'createdAt' => '2025-04-01T08:31:15.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SwitchInstanceZoneFailOver'], ], 'createdAt' => '2025-03-31T08:34:03.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SwitchInstanceZoneFailOver'], ], 'createdAt' => '2025-03-31T02:08:00.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'CreateBackup'], ['description' => 'Error codes changed', 'api' => 'DescribeAccounts'], ], 'createdAt' => '2025-03-25T11:18:33.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2025-03-14T08:05:12.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeEncryptionKey'], ], 'createdAt' => '2025-03-13T12:03:03.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyInstanceAutoRenewalAttribute'], ], 'createdAt' => '2025-02-27T12:09:50.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeInstances'], ], 'createdAt' => '2025-02-27T08:29:17.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2025-02-27T06:33:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'MigrateToOtherZone'], ], 'createdAt' => '2025-02-19T09:16:10.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeAvailableResource'], ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceAttribute'], ], 'createdAt' => '2025-02-18T06:23:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DeleteShardingNode'], ], 'createdAt' => '2025-02-17T03:45:06.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribePrice'], ], 'createdAt' => '2025-02-10T11:34:53.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackupTasks'], ['description' => 'Request parameters changed', 'api' => 'DescribeClusterBackupList'], ], 'createdAt' => '2025-01-15T06:37:35.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeClusterBackupList'], ], 'createdAt' => '2024-12-27T09:29:40.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceConfig'], ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceConfig'], ], 'createdAt' => '2024-12-11T07:57:02.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SwitchInstanceZoneFailOver'], ], 'createdAt' => '2024-12-04T02:47:20.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceSpec'], ], 'createdAt' => '2024-12-04T02:42:32.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceConfig'], ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceConfig'], ], 'createdAt' => '2024-12-03T02:53:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2024-11-20T01:49:20.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'MasterNodeShutDownFailOver'], ], 'createdAt' => '2024-11-12T09:29:05.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceSpec'], ], 'createdAt' => '2024-11-06T11:34:08.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceConfig'], ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceConfig'], ], 'createdAt' => '2024-11-05T14:48:52.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceAttribute'], ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], ], 'createdAt' => '2024-10-09T05:57:22.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2024-10-09T03:21:32.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeRoleZoneInfo'], ], 'createdAt' => '2024-09-26T13:09:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'TransformToPrePaid'], ], 'createdAt' => '2024-09-09T12:54:05.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeBackups'], ], 'createdAt' => '2024-09-06T02:35:50.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyParameterGroup'], ], 'createdAt' => '2024-08-06T06:49:24.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceParameter'], ], 'createdAt' => '2024-08-05T08:39:57.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribePrice'], ], 'createdAt' => '2024-07-31T03:06:29.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2024-07-30T05:39:40.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateAccount'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteAccount'], ['description' => 'Request parameters changed', 'api' => 'GrantAccountPrivilege'], ['description' => 'Request parameters changed', 'api' => 'ModifyAccountDescription'], ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ModifyAccountPassword'], ['description' => 'Request parameters changed', 'api' => 'ResetAccountPassword'], ], 'createdAt' => '2024-07-11T12:25:43.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], ], 'createdAt' => '2024-06-19T12:39:30.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeParameterGroup'], ['description' => 'Request parameters changed', 'api' => 'DescribeParameterGroups'], ['description' => 'Request parameters changed', 'api' => 'ModifyParameterGroup'], ], 'createdAt' => '2024-06-17T11:40:12.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ['description' => 'Response parameters changed', 'api' => 'DescribeBackups'], ['description' => 'Response parameters changed', 'api' => 'DescribeClusterBackupList'], ], 'createdAt' => '2024-05-23T02:14:34.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyBackupPolicy'], ], 'createdAt' => '2024-05-16T15:56:17.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2024-05-10T07:41:54.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeHistoryMonitorValues'], ], 'createdAt' => '2024-05-08T15:48:48.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackups'], ], 'createdAt' => '2024-05-06T11:19:27.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2024-04-26T07:25:09.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateGlobalDistributeCache'], ], 'createdAt' => '2024-04-22T13:32:31.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeEngineVersion'], ], 'createdAt' => '2024-04-22T13:16:58.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribePrice'], ], 'createdAt' => '2024-04-10T07:57:41.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribePrice'], ], 'createdAt' => '2024-04-07T05:48:58.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeBackups'], ['description' => 'Response parameters changed', 'api' => 'DescribeBackupTasks'], ], 'createdAt' => '2024-03-26T02:50:52.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribePrice'], ], 'createdAt' => '2024-03-26T02:05:13.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceSpec'], ], 'createdAt' => '2024-03-21T09:44:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribePrice'], ], 'createdAt' => '2024-02-28T03:07:37.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'AllocateInstancePublicConnection'], ['description' => 'Error codes changed', 'api' => 'DeleteAccount'], ['description' => 'Error codes changed', 'api' => 'DescribeEncryptionKey'], ['description' => 'Error codes changed', 'api' => 'SwitchNetwork'], ], 'createdAt' => '2024-02-26T09:46:34.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeClusterBackupList'], ], 'createdAt' => '2024-02-21T07:15:41.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyBackupPolicy'], ], 'createdAt' => '2024-01-30T11:36:21.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'RenewInstance'], ], 'createdAt' => '2024-01-30T11:28:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceSpec'], ], 'createdAt' => '2024-01-29T03:37:15.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackups'], ['description' => 'Response parameters changed', 'api' => 'DescribeClusterBackupList'], ], 'createdAt' => '2024-01-22T09:03:03.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2024-01-12T06:21:11.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2024-01-12T03:40:05.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeBackups'], ], 'createdAt' => '2024-01-03T02:43:19.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2024-01-03T02:31:52.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceSpec'], ], 'createdAt' => '2023-12-27T03:45:41.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeDBInstanceNetInfo'], ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceAttribute'], ], 'createdAt' => '2023-12-27T03:41:03.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2023-12-22T03:18:59.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ModifyResourceGroup'], ], 'createdAt' => '2023-11-24T06:32:05.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'TransformInstanceChargeType'], ], 'createdAt' => '2023-11-21T08:50:30.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackupPolicy'], ['description' => 'Response parameters changed', 'api' => 'DescribeBackups'], ['description' => 'Response parameters changed', 'api' => 'DescribeBackupTasks'], ], 'createdAt' => '2023-11-13T03:50:07.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackups'], ['description' => 'Response parameters changed', 'api' => 'DescribeBackupTasks'], ], 'createdAt' => '2023-11-06T03:24:23.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackupPolicy'], ], 'createdAt' => '2023-11-06T03:12:24.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeEngineVersion'], ], 'createdAt' => '2023-10-18T10:37:14.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceAttribute'], ], 'createdAt' => '2023-10-13T03:15:45.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribePrice'], ], 'createdAt' => '2023-09-18T06:07:21.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ModifyInstanceTDE'], ], 'createdAt' => '2023-09-14T02:23:57.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2023-09-05T08:11:00.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackupPolicy'], ], 'createdAt' => '2023-08-31T06:36:42.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'AddShardingNode'], ], 'createdAt' => '2023-08-30T07:49:46.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2023-08-28T06:35:09.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2023-08-24T06:02:45.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeLogicInstanceTopology'], ], 'createdAt' => '2023-08-21T06:42:28.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'DescribeInstanceSSL'], ['description' => 'Error codes changed', 'api' => 'DescribeInstanceTDEStatus'], ['description' => 'Error codes changed', 'api' => 'DescribeSecurityIps'], ], 'createdAt' => '2023-08-16T03:19:55.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'DescribeAuditLogConfig'], ['description' => 'Error codes changed', 'api' => 'DescribeSecurityGroupConfiguration'], ], 'createdAt' => '2023-08-16T03:15:45.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeAvailableResource'], ], 'createdAt' => '2023-07-25T12:06:34.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeBackupPolicy'], ['description' => 'Response parameters changed', 'api' => 'DescribeBackups'], ['description' => 'Response parameters changed', 'api' => 'DescribeBackupTasks'], ], 'createdAt' => '2023-07-25T11:34:12.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateGlobalDistributeCache'], ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2023-07-25T07:30:29.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CheckCloudResourceAuthorized'], ['description' => 'Error codes changed', 'api' => 'FlushExpireKeys'], ], 'createdAt' => '2023-07-20T02:34:08.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeClusterMemberInfo'], ], 'createdAt' => '2023-07-06T03:24:36.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'AddShardingNode'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteShardingNode'], ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceSpec'], ], 'createdAt' => '2023-07-04T12:59:04.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2023-06-29T01:52:34.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2023-06-26T06:05:24.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2023-06-21T09:06:28.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2023-06-21T07:47:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeInstancesOverview'], ], 'createdAt' => '2023-06-12T09:03:42.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeIntranetAttribute'], ['description' => 'Request parameters changed', 'api' => 'EnableAdditionalBandwidth'], ], 'createdAt' => '2023-06-06T08:07:51.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'DescribeInstanceConfig'], ['description' => 'Error codes changed', 'api' => 'DescribeZones'], ], 'createdAt' => '2023-05-08T09:41:14.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'RemoveSubInstance'], ], 'createdAt' => '2023-05-05T07:45:27.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'FlushInstance'], ], 'createdAt' => '2023-04-26T08:33:52.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'DescribeMonitorItems'], ], 'createdAt' => '2023-04-24T08:37:22.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2023-04-23T11:17:13.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'ModifyResourceGroup'], ], 'createdAt' => '2023-04-23T06:05:23.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], ], 'createdAt' => '2023-04-13T07:09:09.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceSSL'], ], 'createdAt' => '2023-04-11T05:54:55.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ModifyBackupPolicy'], ], 'createdAt' => '2023-04-03T12:59:30.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2023-04-03T08:17:59.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'AddShardingNode'], ['description' => 'Response parameters changed, Error codes changed', 'api' => 'CreateBackup'], ['description' => 'Response parameters changed', 'api' => 'CreateGlobalDistributeCache'], ['description' => 'Response parameters changed', 'api' => 'DeleteAccount'], ['description' => 'Response parameters changed, Error codes changed', 'api' => 'InitializeKvstorePermission'], ['description' => 'Response parameters changed', 'api' => 'ModifyInstanceAttribute'], ['description' => 'Response parameters changed, Error codes changed', 'api' => 'ModifyInstanceAutoRenewalAttribute'], ['description' => 'Response parameters changed', 'api' => 'ModifyInstanceMaintainTime'], ['description' => 'Response parameters changed', 'api' => 'ModifyInstanceTDE'], ], 'createdAt' => '2023-03-24T08:25:35.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstancesOverview'], ], 'createdAt' => '2023-03-24T08:24:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceAttribute'], ], 'createdAt' => '2023-03-24T08:23:58.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeIntranetAttribute'], ], 'createdAt' => '2023-03-24T08:22:00.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2023-01-10T03:26:25.000Z', 'description' => 'CreateTairInstance 增加 tag 参数', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeBackups'], ], 'createdAt' => '2022-11-29T09:11:18.000Z', 'description' => '增加生成备份对应的备份任务的 id', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'RestoreInstance'], ], 'createdAt' => '2022-11-22T11:43:06.000Z', 'description' => 'pitr 支持 time shift', ], [ 'apis' => [ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'CreateGlobalDistributeCache'], ], 'createdAt' => '2022-11-16T08:30:55.000Z', 'description' => '创建全球多活去掉多余的响应参数', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeEngineVersion'], ], 'createdAt' => '2022-11-15T06:29:24.000Z', 'description' => '返回 SSL 相关参数', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ['description' => 'Error codes changed', 'api' => 'DescribeClusterMemberInfo'], ], 'createdAt' => '2022-11-14T08:15:54.000Z', 'description' => 'tair_essd增加存储类型级别pl0,1,2,3', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceAttribute'], ], 'createdAt' => '2022-11-02T12:41:43.000Z', 'description' => '修复 DescribeInstanceAttribute 对虚拟规格实例返回实际的实例规格', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeEngineVersion'], ], 'createdAt' => '2022-09-26T11:40:05.000Z', 'description' => '发布参数修改', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'AddShardingNode'], ['description' => 'Request parameters changed', 'api' => 'AddShardingNode'], ['description' => 'Request parameters changed', 'api' => 'DescribeParameterModificationHistory'], ['description' => 'Request parameters changed', 'api' => 'DescribeParameterModificationHistory'], ], 'createdAt' => '2022-09-16T08:11:18.000Z', 'description' => '查询引擎版本增加5.5版本返回值', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeParameterModificationHistory'], ], 'createdAt' => '2022-08-23T12:02:24.000Z', 'description' => 'redis增加查看参数修改历史的控制台功能和api', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2022-08-23T11:39:39.000Z', 'description' => 'CreateInstance 接口不在支持经典网络实例创建', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ['description' => 'Error codes changed', 'api' => 'DescribeDBInstanceNetInfo'], ], 'createdAt' => '2022-07-27T12:04:24.000Z', 'description' => '读写分离on ecs', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DeleteShardingNode'], ['description' => 'Response parameters changed', 'api' => 'DescribeInstanceAttribute'], ], 'createdAt' => '2022-07-14T12:20:20.000Z', 'description' => 'ECS读写分离架构', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2022-06-15T06:01:43.000Z', 'description' => 'ShardCount配置默认值为1', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'CreateInstance'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateTairInstance'], ], 'createdAt' => '2022-06-15T03:57:39.000Z', 'description' => '创建增加OrderId返回', ], [ 'apis' => [ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'AddShardingNode'], ], 'createdAt' => '2022-06-06T06:09:48.000Z', 'description' => 'AddShardingNode超时时间延长到30秒', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], ], 'createdAt' => '2022-05-23T06:51:40.000Z', 'description' => '只读节点不可见', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeInstances'], ], 'createdAt' => '2022-05-23T04:54:04.000Z', 'description' => 'Redis支持大版本7.0', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2022-05-11T08:02:07.000Z', 'description' => '增加shardcount支持创建云盘集群', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstancesOverview'], ], 'createdAt' => '2022-04-27T09:07:42.000Z', 'description' => '文档问题修复', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], ], 'createdAt' => '2022-04-25T12:33:03.000Z', 'description' => 'searchkey返回值去掉', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], ], 'createdAt' => '2022-03-30T09:07:58.000Z', 'description' => 'DescribeInstances增加EdtionType', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DeleteShardingNode'], ], 'createdAt' => '2022-03-23T02:56:16.000Z', 'description' => 'fix DeleteShardingNode ShardCount type.', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'RenewInstance'], ], 'createdAt' => '2022-03-15T03:56:29.000Z', 'description' => 'RenewInstance支持ClientToken幂等参数', ], [ 'apis' => [ ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeInstanceAttribute'], ['description' => 'Response parameters changed', 'api' => 'DescribeInstances'], ], 'createdAt' => '2022-03-07T08:04:14.000Z', 'description' => '云盒展示cloudType字段', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateInstance'], ['description' => 'Error codes changed', 'api' => 'CreateInstances'], ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceSpec'], ], 'createdAt' => '2022-02-22T15:02:47.000Z', 'description' => 'ModifyInstanceSpec 参数OrderType增加AUTO参数', ], [ 'apis' => [ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DeleteShardingNode'], ], 'createdAt' => '2022-02-22T13:16:01.000Z', 'description' => 'DeleteShardingNode增加ShardCount分片数量', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2022-01-04T12:21:47.000Z', 'description' => '增加CreateInstance错误码映射', ], [ 'apis' => [ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeBackupTasks'], ], 'createdAt' => '2021-12-16T06:00:15.000Z', 'description' => '修复DescribeBackupTasks 500错误', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'ModifyInstanceSpec'], ], 'createdAt' => '2021-12-14T09:29:09.000Z', 'description' => '补全错误码', ], [ 'apis' => [ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeDedicatedClusterInstanceList'], ], 'createdAt' => '2021-12-14T04:01:45.000Z', 'description' => '调整action参数顺序', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateInstance'], ['description' => 'Request parameters changed', 'api' => 'DescribeParameters'], ['description' => 'Request parameters changed', 'api' => 'ModifyInstanceSpec'], ], 'createdAt' => '2021-12-08T07:58:22.000Z', 'description' => '新增错误码映射', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2021-12-07T15:37:24.000Z', 'description' => '增加国际站后付费风控错误码', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'DescribeInstancesOverview'], ], 'createdAt' => '2021-11-23T14:24:06.000Z', 'description' => '新增API：DescribeDBInstancesOverview', ], [ 'apis' => [ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'ModifyInstanceSpec'], ], 'createdAt' => '2021-11-03T13:44:30.000Z', 'description' => '增加错误码映射', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DescribeInstances'], ['description' => 'Error codes changed', 'api' => 'DescribeRegions'], ], 'createdAt' => '2021-10-25T13:33:14.000Z', 'description' => 'describeRegions优化', ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteBackup'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckCloudResourceAuthorized'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceMonitor'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransformInstanceChargeType'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroupTemplateList'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SwitchInstanceHA'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchNetwork'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstancesOverview'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteShardingNode'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTask'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGlobalSecurityIPGroup'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceConnectionString'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroup'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTags'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifySecurityGroupConfiguration'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTaskCount'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAccount'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGlobalDistributeCache'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGlobalSecurityIPGroup'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitializeKvstorePermission'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryMonitorValues'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewInstance'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceMinorVersion'], ['threshold' => '1', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBInstanceMonitor'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSecurityGroupConfiguration'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstances'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstances'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceVpcAuthMode'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameters'], ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeHistoryTasksStat'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTairKVCacheVNode'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceConfig'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalDistributeCache'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceNetExpireTime'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AllocateInstancePublicConnection'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceTDEStatus'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'EnableAdditionalBandwidth'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceSpec'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyBackupExpireTime'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSubInstance'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroups'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AllocateDirectConnection'], ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceAutoRenewalAttribute'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FlushInstanceForDB'], ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAuditRecords'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackups'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceMajorVersion'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceBandwidth'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParameterGroup'], ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTairKVCacheInferInstances'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceAttribute'], ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInstanceAutoRenewalAttribute'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeClusterBackupList'], ['threshold' => '1', 'countWindow' => 30, 'regionId' => '*', 'api' => 'MasterNodeShutDownFailOver'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceAttribute'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewAdditionalBandwidth'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTairInstance'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAuditLogConfig'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEncryptionKey'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalSecurityIPGroupRelation'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySecurityIps'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GrantAccountPrivilege'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAccountPassword'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationMaintenanceConfig'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransformToPrePaid'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockDBInstanceWrite'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCacheAnalysisReportList'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBNodeDirectVipInfo'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTaskInfo'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyInstanceConfig'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'FlushExpireKeys'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], ['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SwitchInstanceZoneFailOver'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGlobalSecurityIPGroup'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIntranetAttribute'], ['threshold' => '15', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateInstance'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCacheAnalysisTask'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeClusterMemberInfo'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterGroupSupportParam'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParameterTemplates'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroupName'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDbInstanceConnectivity'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DestroyInstance'], ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRunningLogRecords'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeProxy'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeEngineVersion'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZones'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FlushInstance'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAvailableResource'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDBInstanceNetInfo'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSecurityIps'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyActiveOperationTasks'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDBInstanceAutoUpgrade'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceTDE'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyActiveOperationMaintainConfig'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstancePublicConnection'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceSSL'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAuditLogConfig'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeActiveOperationTasks'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDedicatedClusterInstanceList'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddShardingNode'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceParameter'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateBackup'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyIntranetAttribute'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateParameterGroup'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMonitorItems'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeLogicInstanceTopology'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCacheAnalysisReport'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyResourceGroup'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SyncDtsStatus'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryTasks'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchInstanceProxy'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestoreInstance'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockDBInstanceWrite'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEncryptionKeyList'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RestartInstance'], ['threshold' => '10000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceMaintainTime'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateToOtherZone'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebootProxy'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccount'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelActiveOperationTasks'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeParameterModificationHistory'], ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSlowLogRecords'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceSSL'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransformToEcs'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroup'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAccountPassword'], ['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccounts'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePrice'], ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeServiceLinkedRoleExists'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteParameterGroup'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReleaseDirectConnection'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryEvents'], ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRoleZoneInfo'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupTasks'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHistoryEventsStat'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyEventInfo'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackupPolicy'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyActiveOperationTask'], ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyGlobalSecurityIPGroupRelation'], ], 'product' => ['code' => 'kvstore', 'title' => 'R-kvstore'], ], 'ram' => [ 'productCode' => 'Redis', 'productName' => 'Tair (Redis OSS-compatible)', 'ramCodes' => ['kvstore'], 'ramLevel' => 'RESOURCE', 'ramConditions' => [ [ 'name' => 'kvstore:EnableBackupLog', 'schema' => ['type' => 'String', 'description' => 'Enable data flashback feature, 1: Enable data flashback feature; 0: Disable data flashback feature'], ], [ 'name' => 'kvstore:DbAudit', 'schema' => ['type' => 'Boolean', 'description' => 'Audit log enabled status'], ], [ 'name' => 'kvstore:InstanceType', 'schema' => ['type' => 'String', 'description' => 'The instance type. When creating a Redis instance, the value is Redis or Memcache. When creating a Tair instance, the value is tair_rdb, tair_scm, or tair_essd.'], ], [ 'name' => 'kvstore:VpcAuthMode', 'schema' => ['type' => 'String', 'description' => 'In the authentication mode of a private network, Open: Passed password authentication; Close: Disable password authentication, that is, enable password-free access.'], ], [ 'name' => 'kvstore:InstanceAofConfig', 'schema' => ['type' => 'String', 'description' => 'Instance AOF parameter configuration'], ], [ 'name' => 'kvstore:Appendonly', 'schema' => ['type' => 'String', 'description' => 'For instance AOF configuration, yes to enable AOF persistence; no to disable AOF persistence'], ], [ 'name' => 'kvstore:TDEStatus', 'schema' => ['type' => 'String', 'description' => 'Enable Transparent Data Encryption (TDE) for the instance'], ], [ 'name' => 'kvstore:SSLEnabled', 'schema' => ['type' => 'String', 'description' => 'Whether to enable TLS (SSL) encryption'], ], [ 'name' => 'kvstore:ResourceTag', 'schema' => ['type' => 'String', 'description' => 'Redis tag information, it is used in combination with tag key, kvstore:ResourceTag/<tag-key>. Example: Assuming the tag is team:dev, the condition key and value are \\\\\\\\\\\\"kvstore:ResourceTag/team\\\\\\\\\\\\": \\\\\\\\\\\\"dev\\\\\\\\\\\\"'], ], [ 'name' => 'kvstore:InstanceClass', 'schema' => ['type' => 'String', 'description' => 'The instance type. Example: redis.master.small.default. Value Source: the value of the request parameter InstanceClass.'], ], [ 'name' => 'kvstore:TLSVersion', 'schema' => ['type' => 'String', 'description' => 'TLS protocol version used'], ], ], 'ramActions' => [ [ 'apiName' => 'DescribeRunningLogRecords', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeRunningLogRecords', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DeleteShardingNode', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DeleteShardingNode', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'TransformToPrePaid', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:TransformToPrePaid', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeRoleZoneInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeRoleZoneInfo', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyInstanceNetExpireTime', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceNetExpireTime', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'UntagResources', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:UntagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeEncryptionKey', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeEncryptionKey', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyInstanceSSL', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceSSL', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:SSLEnabled', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'FlushExpireKeys', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:FlushExpireKeys', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ], [ 'apiName' => 'ListTagResources', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:ListTagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/*'], ], ], ], [ 'apiName' => 'ModifySecurityGroupConfiguration', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifySecurityGroupConfiguration', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ], [ 'apiName' => 'InitializeKvstorePermission', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:InitializeKvstorePermission', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateGlobalDistributeCache', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:CreateGlobalDistributeCache', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeEngineVersion', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeEngineVersion', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeAuditLogConfig', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeAuditLogConfig', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeAvailableResource', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeAvailableResource', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateCacheAnalysisTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateCacheAnalysisTask', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'RestartInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:RestartInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ], [ 'apiName' => 'LockDBInstanceWrite', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:LockDBInstanceWrite', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyInstanceVpcAuthMode', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceVpcAuthMode', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:VpcAuthMode', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeParameterGroupSupportParam', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeParameterGroupSupportParam', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyInstanceAttribute', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyDBInstanceAutoUpgrade', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyDBInstanceAutoUpgrade', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTairSkvDdbTableSchema', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeTairSkvDdbTableSchema', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeDedicatedClusterInstanceList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeDedicatedClusterInstanceList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTairKVCacheInferInstances', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'kvstore:DescribeTairKVCacheInferInstances', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyInstanceTDE', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceTDE', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:TDEStatus', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeParameterModificationHistory', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeParameterModificationHistory', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'], ], ], ], [ 'apiName' => 'DescribeBackups', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeBackups', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyIntranetAttribute', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyIntranetAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeAccounts', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeAccounts', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeEncryptionKeyList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeEncryptionKeyList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteAccount', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DeleteAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyBackupExpireTime', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyBackupExpireTime', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'TagResources', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:TagResources', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyGlobalSecurityIPGroupName', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyGlobalSecurityIPGroupName', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeActiveOperationTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeActiveOperationTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyInstanceParameter', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceParameter', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AllocateDirectConnection', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:AllocateDirectConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DeleteGlobalSecurityIPGroup', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DeleteGlobalSecurityIPGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateInstanceMultiVIP', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateInstanceMultiVIP', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeBackupTasks', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeBackupTasks', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'CreateBackup', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateBackup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeServiceLinkedRoleExists', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeServiceLinkedRoleExists', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FlushInstanceForDB', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:FlushInstanceForDB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FlushInstance', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:FlushInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeParameterTemplates', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeParameterTemplates', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeLogicInstanceTopology', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeLogicInstanceTopology', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SyncDtsStatus', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:SyncDtsStatus', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyEventInfo', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyEventInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyResourceGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyResourceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSecurityGroupConfiguration', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeSecurityGroupConfiguration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'dbinstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ], [ 'apiName' => 'ModifyAccountDescription', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyAccountDescription', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'AddShardingNode', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:AddShardingNode', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeCacheAnalysisReport', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeCacheAnalysisReport', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'dbinstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ], [ 'apiName' => 'DescribeParameterGroups', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'kvstore:DescribeParameterGroups', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RebootProxy', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:RebootProxy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyDBInstanceMonitor', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyDBInstanceMonitor', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTairSkvDdbTable', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeTairSkvDdbTable', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeDBInstanceNetInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeDBInstanceNetInfo', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyGlobalSecurityIPGroupRelation', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyGlobalSecurityIPGroupRelation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeInstanceMultiVIP', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'kvstore:DescribeInstanceMultiVIP', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeCacheAnalysisReportList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeCacheAnalysisReportList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ReleaseInstancePublicConnection', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:ReleaseInstancePublicConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyActiveOperationMaintainConfig', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyActiveOperationMaintainConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'TransformInstanceChargeType', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:TransformInstanceChargeType', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SwitchInstanceProxy', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:SwitchInstanceProxy', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateParameterGroup', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateParameterGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeAuditRecords', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeAuditRecords', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeMonitorItems', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeMonitorItems', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifySecurityIps', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifySecurityIps', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'EnableAdditionalBandwidth', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:EnableAdditionalBandwidth', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateTairInstance', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateTairInstance', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:InstanceClass', 'validationType' => 'always'], ['conditionKey' => 'kvstore:InstanceType'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/*'], ], ], ], [ 'apiName' => 'DescribeHistoryTasks', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeHistoryTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ResetAccountPassword', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ResetAccountPassword', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeInstanceConfig', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeInstanceConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDbInstanceConnectivity', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeDbInstanceConnectivity', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyAccountPassword', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyAccountPassword', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyInstanceMinorVersion', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceMinorVersion', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeInstancesOverview', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeInstancesOverview', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'TransformToEcs', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:TransformToEcs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyInstanceBandwidth', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceBandwidth', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'MigrateToOtherZone', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:MigrateToOtherZone', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'CheckCloudResourceAuthorized', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:CheckCloudResourceAuthorized', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateTairSkvDdbTable', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateTairSkvDdbTable', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateInstances', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateInstances', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:InstanceClass', 'validationType' => 'conditional'], ['conditionKey' => 'kvstore:InstanceType', 'validationType' => 'conditional'], ['conditionKey' => 'kvstore:Appendonly'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/*'], ], ], ], [ 'apiName' => 'DescribeDBNodeDirectVipInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeDBNodeDirectVipInfo', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeTags', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeTags', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyGlobalSecurityIPGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyGlobalSecurityIPGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeHistoryMonitorValues', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeHistoryMonitorValues', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:ResourceTag', 'validationType' => 'always'], ['conditionKey' => 'kvstore:ResourceTag', 'validationType' => 'always'], ['conditionKey' => 'kvstore:ResourceTag', 'validationType' => 'always'], ['conditionKey' => 'kvstore:ResourceTag', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'CreateTairSkvDdbWorkspace', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateTairSkvDdbWorkspace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyParameterGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyParameterGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeActiveOperationTaskCount', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeActiveOperationTaskCount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateInstance', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateInstance', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:InstanceClass', 'validationType' => 'always'], ['conditionKey' => 'kvstore:Appendonly', 'validationType' => 'always'], ['conditionKey' => 'kvstore:InstanceType', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/*'], ], ], ], [ 'apiName' => 'ModifyInstanceAutoRenewalAttribute', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceAutoRenewalAttribute', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeClusterBackupList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeClusterBackupList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'AllocateInstancePublicConnection', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:AllocateInstancePublicConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DeleteBackup', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DeleteBackup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteParameterGroup', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DeleteParameterGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeGlobalSecurityIPGroup', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeGlobalSecurityIPGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyTaskInfo', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyTaskInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyActiveOperationTask', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyActiveOperationTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyActiveOperationTasks', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SwitchInstanceHA', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:SwitchInstanceHA', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeParameterGroup', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeParameterGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RestoreInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:RestoreInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeActiveOperationMaintenanceConfig', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeActiveOperationMaintenanceConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeParameters', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeParameters', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}'], ], ], ], [ 'apiName' => 'DescribeSlowLogRecords', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeSlowLogRecords', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ], [ 'apiName' => 'DescribeHistoryEvents', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:DescribeHistoryEvents', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribePrice', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribePrice', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBInstanceMonitor', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeDBInstanceMonitor', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyInstanceSpec', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceSpec', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeActiveOperationTasks', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SwitchNetwork', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:SwitchNetwork', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DestroyInstance', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DestroyInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeHistoryTasksStat', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeHistoryTasksStat', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeGlobalDistributeCache', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeGlobalDistributeCache', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyInstanceMajorVersion', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceMajorVersion', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeHistoryEventsStat', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeHistoryEventsStat', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeIntranetAttribute', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeIntranetAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeInstanceAttribute', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeInstanceAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'CreateAccount', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateAccount', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'GrantAccountPrivilege', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:GrantAccountPrivilege', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeParameterGroupTemplateList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'kvstore:DescribeParameterGroupTemplateList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeInstanceTDEStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeInstanceTDEStatus', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeClusterMemberInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeClusterMemberInfo', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeSecurityIps', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeSecurityIps', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeBackupPolicy', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeBackupPolicy', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'CancelActiveOperationTasks', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:CancelActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateGlobalSecurityIPGroup', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateGlobalSecurityIPGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyDBInstanceConnectionString', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyDBInstanceConnectionString', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeInstanceAutoRenewalAttribute', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeInstanceAutoRenewalAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyAuditLogConfig', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyAuditLogConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:DbAudit', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'DeleteInstance', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:DeleteInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'DescribeGlobalSecurityIPGroupRelation', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeGlobalSecurityIPGroupRelation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ReleaseDirectConnection', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'kvstore:ReleaseDirectConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'UpgradeProxy', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:UpgradeProxy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeInstances', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'kvstore:DescribeInstances', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'conditional', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/*'], ['validationType' => 'conditional', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'RemoveSubInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:RemoveSubInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SwitchInstanceZoneFailOver', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:SwitchInstanceZoneFailOver', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'RenewAdditionalBandwidth', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:RenewAdditionalBandwidth', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyInstanceMaintainTime', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceMaintainTime', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'MasterNodeShutDownFailOver', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'kvstore:MasterNodeShutDownFailOver', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'UnlockDBInstanceWrite', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:UnlockDBInstanceWrite', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateTairKVCacheVNode', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'kvstore:CreateTairKVCacheVNode', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeInstanceSSL', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'kvstore:DescribeInstanceSSL', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'RenewInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:RenewInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyInstanceConfig', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyInstanceConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:InstanceAofConfig', 'validationType' => 'conditional'], ['conditionKey' => 'kvstore:TLSVersion', 'validationType' => 'conditional'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], [ 'apiName' => 'ModifyBackupPolicy', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'kvstore:ModifyBackupPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'kvstore:EnableBackupLog', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'Redis', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ], ], ], ], 'resourceTypes' => [ ['validationType' => 'always', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}'], ['validationType' => 'always', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'], ['validationType' => 'always', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:instance/*'], ['validationType' => 'always', 'resourceType' => 'TairInstance', 'arn' => 'acs:redis:{#regionId}:{#accountId}:tairinstance/{#TairInstanceId}'], ['validationType' => 'always', 'resourceType' => 'dbinstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}'], ], ], ];