'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'R-kvstore', 'version' => '2015-01-01', ], 'directories' => [ [ 'id' => 67090, 'title' => 'Lifecycle management', 'type' => 'directory', 'children' => [ 'CreateInstance', 'AddShardingNode', 'CreateGlobalDistributeCache', 'DeleteShardingNode', 'DeleteInstance', 'DestroyInstance', 'ModifyInstanceSpec', 'DescribeRegions', 'DescribeZones', 'DescribeAvailableResource', 'TransformToPrePaid', 'MigrateToOtherZone', ], ], [ 'id' => 67103, 'title' => 'Instance management', 'type' => 'directory', 'children' => [ 'CreateTairInstance', 'CreateInstances', 'EnableAdditionalBandwidth', 'ModifyInstanceAttribute', 'ModifyResourceGroup', 'ModifyInstanceMaintainTime', 'ModifyInstanceMajorVersion', 'ModifyInstanceMinorVersion', 'ModifyDBInstanceAutoUpgrade', 'DescribeInstancesOverview', 'DescribeInstances', 'DescribeDedicatedClusterInstanceList', 'DescribeInstanceAttribute', 'DescribeGlobalDistributeCache', 'DescribeEngineVersion', 'DescribeRoleZoneInfo', 'DescribeClusterMemberInfo', 'DescribeDBInstanceNetInfo', 'DescribeDBNodeDirectVipInfo', 'DescribeLogicInstanceTopology', 'RestartInstance', 'FlushExpireKeys', 'FlushInstanceForDB', 'FlushInstance', 'SwitchInstanceHA', 'SyncDtsStatus', 'RemoveSubInstance', 'LockDBInstanceWrite', 'UnlockDBInstanceWrite', 'RebootProxy', 'UpgradeProxy', ], ], [ 'id' => 67126, 'title' => 'Connection management', 'type' => 'directory', 'children' => [ 'ModifyInstanceNetExpireTime', 'ModifyDBInstanceConnectionString', 'ModifyIntranetAttribute', 'DescribeIntranetAttribute', 'SwitchNetwork', 'AllocateInstancePublicConnection', 'ReleaseInstancePublicConnection', 'AllocateDirectConnection', 'ReleaseDirectConnection', 'SwitchInstanceProxy', ], ], [ 'id' => 67137, 'title' => 'Renewal management', 'type' => 'directory', 'children' => [ 'ModifyInstanceAutoRenewalAttribute', 'DescribePrice', 'DescribeInstanceAutoRenewalAttribute', 'RenewAdditionalBandwidth', 'TransformInstanceChargeType', 'RenewInstance', ], ], [ 'id' => 67144, 'title' => 'Account management', 'type' => 'directory', 'children' => [ 'CreateAccount', 'DeleteAccount', 'ModifyAccountDescription', 'ModifyAccountPassword', 'DescribeAccounts', 'ResetAccountPassword', 'GrantAccountPrivilege', ], ], [ 'id' => 67152, 'title' => 'Backup and restoration', 'type' => 'directory', 'children' => [ 'CreateBackup', 'ModifyBackupPolicy', 'DescribeBackupTasks', 'DescribeBackupPolicy', 'DescribeBackups', 'RestoreInstance', 'DescribeClusterBackupList', ], ], [ 'id' => 67159, 'title' => 'Monitoring management', 'type' => 'directory', 'children' => [ 'DescribeDBInstanceMonitor', 'DescribeMonitorItems', 'DescribeHistoryMonitorValues', ], ], [ 'id' => 67162, 'title' => 'Log management', 'type' => 'directory', 'children' => [ 'ModifyAuditLogConfig', 'DescribeAuditLogConfig', 'DescribeAuditRecords', 'DescribeRunningLogRecords', 'DescribeSlowLogRecords', 'InitializeKvstorePermission', 'DescribeServiceLinkedRoleExists', ], ], [ 'id' => 67168, 'title' => 'Network security', 'type' => 'directory', 'children' => [ 'ModifySecurityIps', 'ModifySecurityGroupConfiguration', 'ModifyInstanceSSL', 'ModifyInstanceVpcAuthMode', 'DescribeSecurityIps', 'DescribeSecurityGroupConfiguration', 'DescribeInstanceSSL', ], ], [ 'id' => 67176, 'title' => 'Parameter management', 'type' => 'directory', 'children' => [ 'ModifyInstanceConfig', 'DescribeParameterTemplates', 'DescribeInstanceConfig', 'DescribeParameters', 'DescribeParameterModificationHistory', ], ], [ 'id' => 67181, 'title' => 'Tag management', 'type' => 'directory', 'children' => [ 'ListTagResources', 'TagResources', 'UntagResources', ], ], [ 'id' => 67185, 'title' => 'Performance improvements', 'type' => 'directory', 'children' => [ 'CreateCacheAnalysisTask', 'DescribeCacheAnalysisReport', 'DescribeCacheAnalysisReportList', ], ], [ 'id' => 177761, 'title' => 'TDE', 'type' => 'directory', 'children' => [ 'ModifyInstanceTDE', 'DescribeInstanceTDEStatus', 'DescribeEncryptionKeyList', 'DescribeEncryptionKey', 'CheckCloudResourceAuthorized', ], ], [ 'id' => 67189, 'title' => 'O\\\\\\&M task management', 'type' => 'directory', 'children' => [ 'DescribeActiveOperationTaskCount', 'DescribeHistoryTasks', 'DescribeHistoryTasksStat', 'ModifyActiveOperationTask', 'DescribeActiveOperationTask', 'DescribeActiveOperationMaintenanceConfig', 'ModifyActiveOperationMaintainConfig', ], ], [ 'id' => 187216, 'title' => 'Whitelist template management', 'type' => 'directory', 'children' => [ 'CreateGlobalSecurityIPGroup', 'ModifyGlobalSecurityIPGroupName', 'DescribeGlobalSecurityIPGroupRelation', 'DeleteGlobalSecurityIPGroup', 'ModifyGlobalSecurityIPGroup', 'ModifyGlobalSecurityIPGroupRelation', 'DescribeGlobalSecurityIPGroup', ], ], [ 'id' => 192365, 'title' => 'Parameter Template Management', 'type' => 'directory', 'children' => [ 'ModifyInstanceParameter', 'DeleteParameterGroup', 'DescribeParameterGroupSupportParam', 'DescribeParameterGroup', 'ModifyParameterGroup', 'DescribeParameterGroups', 'CreateParameterGroup', 'DescribeParameterGroupTemplateList', ], ], [ 'id' => 198610, 'title' => 'Event management', 'type' => 'directory', 'children' => [ 'DescribeActiveOperationTasks', 'ModifyActiveOperationTasks', 'CancelActiveOperationTasks', 'ModifyEventInfo', 'DescribeHistoryEvents', 'DescribeHistoryEventsStat', ], ], [ 'id' => 198611, 'title' => 'Fault simulation', 'type' => 'directory', 'children' => [ 'SwitchInstanceZoneFailOver', 'MasterNodeShutDownFailOver', ], ], [ 'id' => 198142, 'title' => 'Other', 'type' => 'directory', 'children' => [ 'ModifyInstanceBandwidth', 'ModifyTaskInfo', 'ModifyBackupExpireTime', 'DeleteBackup', 'CreateTairKVCacheVNode', 'DescribeTairKVCacheInferInstances', 'TransformToEcs', 'ModifyDBInstanceMonitor', 'DescribeTags', 'DescribeDbInstanceConnectivity', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'CreateInstance' => [ 'summary' => 'Creates a Tair (Redis OSS-compatible) instance. If you want to create a Tair (Enterprise Edition) cloud-native instance, you can call the CreateTairInstance operation.', '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 ID of the region where you want to create 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', ], ], [ 'name' => 'Token', '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. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ '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. It cannot contain spaces or specific special characters. These special characters include `@ / : = " < > { [ ] }`'."\n", 'type' => 'string', 'required' => false, 'example' => 'apitest', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => 'The password that is used to connect to 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, digits, and specific special characters. These special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n", 'type' => 'string', 'required' => false, 'example' => 'Pass!123456', ], ], [ '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.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16384', ], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type. For example, redis.master.small.default indicates a Community Edition standard master-replica instance that has 1 GB of memory. For more information, see [Overview](~~26350~~).'."\n" ."\n" .'**'."\n" ."\n" .'**Description** You must specify at least one of the **Capacity** and **InstanceClass** parameters when you call the CreateInstance operation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'redis.master.small.default', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The primary zone ID of the instance. You can call the [DescribeRegions](~~473763~~) operation to query the most recent zone list.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou-e', ], ], [ 'name' => 'SecondaryZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The secondary zone ID of the instance. You can call the [DescribeZones](~~473764~~) operation to query the most recent zone list.'."\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.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **PrePaid**: subscription'."\n" .'* **PostPaid** (default): pay-as-you-go'."\n", 'type' => 'string', 'required' => false, 'example' => 'PostPaid', 'default' => 'PostPaid', 'enum' => [ 'PrePaid', 'PostPaid', ], ], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => [ 'description' => 'The node type. 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' => 'STAND_ALONE', 'default' => 'double', 'enum' => [ 'STAND_ALONE', 'MASTER_SLAVE', 'double', 'single', ], ], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type. Valid value:'."\n" ."\n" .'* **VPC** (default)'."\n", 'type' => 'string', 'required' => false, 'example' => 'VPC', 'default' => 'VPC', 'enum' => [ 'VPC', ], ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1nme44gek34slfc****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch to which you want the instance to connect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1e7clcw529l773d****', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration. Valid values: **1**, 2, 3, 4, 5, 6, 7, 8, **9**, **12**, **24**,**36**, and **60**. Unit: months.'."\n" ."\n" .'> This parameter is available and required only if the **ChargeType** parameter is set to **PrePaid**.'."\n", 'type' => 'string', 'required' => false, 'example' => '12', 'pattern' => '^\\d+$', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the promotional event or business information.'."\n", 'type' => 'string', 'required' => false, 'example' => '000000000', ], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => [ 'description' => 'The coupon code. Default value: `default`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'default' => 'default', ], ], [ 'name' => 'SrcDBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance.'."\n" ."\n" .'> After you specify the SrcDBInstanceId parameter, use the **BackupId**, **ClusterBackupId** (recommended for cloud-native cluster instances), or **RestoreTime** parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'If your instance is a cloud-native cluster instance, we recommend that you use [DescribeClusterBackupList](~~2679168~~) to query the backup set ID of the cluster instance, such as cb-xx. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.'."\n" ."\n" .'You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the [DescribeBackups](~~473823~~) operation to query backup set IDs. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,). Example: "10\\*\\*,11\\*\\*,15\\*\\*".', 'type' => 'string', 'required' => false, 'example' => '111111111', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* **Redis** (default)'."\n" .'* **Memcache**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Redis', 'default' => 'Redis', 'enum' => [ 'Redis', 'Memcache', ], ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The engine version. Valid values for **classic instances**:'."\n" ."\n" .'* **2.8** (not recommended due to [scheduled EOFS](~~2674657~~))'."\n" .'* **4.0** (not recommended)'."\n" .'* **5.0**'."\n" ."\n" .'Valid values for **cloud-native instances**:'."\n" ."\n" .'* **5.0**'."\n" .'* **6.0** (recommended)'."\n" .'* **7.0**'."\n" ."\n" .'> The default value is **5.0**.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ '4.0' => '4.0', '5.0' => '5.0', '6.0' => '6.0', '7.0' => '7.0', '2.8' => '2.8', ], 'example' => '4.0', 'default' => '5.0', 'enum' => [ '2.8', '4.0', '5.0', '6.0', '7.0', ], ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the instance.'."\n" ."\n" .'> The private IP address must be available within the CIDR block of the vSwitch to which to connect the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.16.0.***', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use a coupon. Valid values:'."\n" ."\n" .'* **true**: uses a coupon.'."\n" .'* **false** (default): does not use a coupon.'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'* **true**: enables auto-renewal.'."\n" .'* **false** (default): disables auto-renewal.'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', 'default' => 'false', 'enum' => [ 'true', 'false', ], ], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration that is supported by auto-renewal. Unit: month. Valid values: **1**, **2**, **3**, **6**, and **12**.'."\n" ."\n" .'> This parameter is required if the **AutoRenew** parameter is set to **true**.'."\n", 'type' => 'string', 'required' => false, 'example' => '3', 'default' => '1', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-resourcegroupid1', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'description' => 'If data flashback is enabled for the source instance, you can use this parameter to specify a point in time within the backup retention period of the source instance. The system uses the backup data of the source instance at the point in time to create an instance. 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", 'type' => 'string', 'required' => false, 'example' => '2019-06-19T16:00:00Z', ], ], [ 'name' => 'DedicatedHostGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the dedicated cluster. This parameter is required if you create an instance in a dedicated cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dhg-uv4fnk6r7zff****', ], ], [ 'name' => 'ShardCount', 'in' => 'query', 'schema' => [ 'description' => 'The number of shards. This parameter applies only to cloud-native cluster instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '128', 'minimum' => '1', 'example' => '4', 'default' => '1', ], ], [ 'name' => 'ReplicaCount', 'in' => 'query', 'schema' => [ 'description' => 'The number of slave replicas in the primary availability zone. This parameter is applicable only for creating cloud-native cluster edition multi-replica instances, allowing you to customize the number of slave replicas. The value range is 1 to 4.'."\n" .'> > - The sum of this parameter and SlaveReplicaCount cannot exceed 4. '."\n" .'>> - Only one of this parameter and ReadOnlyCount can be passed; there are no instances that simultaneously include both replicas and read-only nodes. '."\n" .'>> - Primary-secondary instances do not support multiple replicas.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '2', ], ], [ 'name' => 'SlaveReplicaCount', 'in' => 'query', 'schema' => [ 'description' => 'Used for specifying the number of slave replicas in the secondary availability zone when creating a multi-AZ cloud-native cluster edition with multiple replicas. The sum of this parameter and ReplicaCount cannot exceed 4. When creating a multi-AZ cloud-native cluster edition with multiple replicas, both SlaveReplicaCount and SecondaryZoneId parameters must be specified.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '2', ], ], [ 'name' => 'ReadOnlyCount', 'in' => 'query', 'schema' => [ 'description' => 'The number of read replicas in the primary zone. This parameter applies only to read/write splitting instances that use cloud disks. You can use this parameter to customize the number of read replicas. Valid values: 1 to 9.'."\n" ."\n" .'> The sum of the values of this parameter and SlaveReadOnlyCount cannot be greater than 9.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '5', 'minimum' => '0', 'example' => '5', ], ], [ 'name' => 'SlaveReadOnlyCount', 'in' => 'query', 'schema' => [ 'description' => 'The number of read replicas in the secondary zone. This parameter is used to create a read/write splitting instance that is deployed across multiple zones. The sum of the values of this parameter and ReadOnlyCount cannot be greater than 9.'."\n" ."\n" .'> When you create a multi-zone read/write splitting instance, you must specify both SlaveReadOnlyCount and SecondaryZoneId.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '2', ], ], [ 'name' => 'GlobalInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the distributed instance. This parameter is available only on the China site (aliyun.com).'."\n", 'type' => 'string', 'required' => false, 'example' => 'gr-bp14rkqrhac****', ], ], [ 'name' => 'GlobalInstance', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use the new instance as the first child instance of a distributed instance. Valid values:'."\n" ."\n" .'* **true**: uses the new instance as the first child instance.'."\n" .'* **false** (default): does not use the new instance as the first child instance.'."\n" ."\n" .'> '."\n" ."\n" .'* If you want to create a Tair DRAM-based instance that runs Redis 5.0, you must set this parameter to **true**.'."\n" ."\n" .'* This parameter is available only on the China site (aliyun.com).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => 'The port number that is used to connect to the instance. Valid values: **1024** to **65535**. Default value: **6379**.'."\n", 'type' => 'string', 'required' => false, 'example' => '6379', 'maxLength' => 5, 'minLength' => 1, 'pattern' => '^\\d+$', ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" ."\n" .'* **true**: performs a dry run and does not create the instance. The system prechecks the request parameters, request format, service limits, and available resources. If the request fails to pass the precheck, an error message is returned. If the request passes the precheck, the `DryRunOperation` error code is returned.'."\n" .'* **false**: performs a dry run and sends the request. If the request passes the dry run, the instance is created.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'GlobalSecurityGroupIds', 'in' => 'query', 'schema' => [ 'description' => 'The global IP whitelist template for the instance. Multiple IP whitelist templates should be separated by English commas (,) and cannot be duplicated.', 'type' => 'string', 'required' => false, 'example' => 'g-zsldxfiwjmti0kcm****', ], ], [ 'name' => 'Appendonly', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable append-only file (AOF) persistence for the instance. Valid values:'."\n" ."\n" .'* **yes** (default): enables AOF persistence.'."\n" .'* **no**: disables AOF persistence.'."\n" ."\n" .'**'."\n" ."\n" .'**Description** This parameter is applicable to classic instances, and is unavailable for cloud-native instances.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'no' => 'no', 'yes' => 'yes', ], 'example' => 'yes', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'description' => 'The operation that you want to perform. Set the value to **AllocateInstancePublicConnection**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'ParamGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The parameter template ID, which must be globally unique.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rpg-test**', ], ], [ '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 keys of the tags that are added to the instance.'."\n" ."\n" .'> * **N** specifies the serial number of the tag. Up to 20 tags can be added 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 key of the tag does not exist, the tag is automatically created.', 'type' => 'string', 'required' => false, 'example' => 'testkey', ], 'Value' => [ 'description' => 'The values of the tags that are added to 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' => false, 'example' => 'testvalue', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'ClusterBackupId', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is supported for specific new cluster instances. You can query the backup set ID by using the [DescribeClusterBackupList](~~2679168~~) operation.'."\n" ."\n" .'* If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the **BackupId** parameter.'."\n" .'* If this parameter is not supported, set the BackupId parameter to the IDs of backup sets for all shards of the source instance, separated by commas (,). Example: "2158\\*\\*\\*\\*20,2158\\*\\*\\*\\*22".', 'type' => 'string', 'required' => false, 'example' => 'cb-hyxdof5x9kqbtust'."\n", ], ], [ 'name' => 'RecoverConfigMode', 'in' => 'query', 'schema' => [ 'description' => 'When creating an instance using a specified backup set, whether to restore account, kernel parameter (whitelist), and whitelist (config) information from the original backup set. For example, if you need to restore account information, the value should be `{"account":true}`.'."\n" .'By default, it is empty, indicating that no account, kernel parameter, or whitelist information will be restored from the original backup set. '."\n" .'> This parameter applies only to cloud-native instances and requires that the original backup set has saved the account, kernel parameter, and whitelist information. You can use the [DescribeBackups](~~473823~~) API to check if the RecoverConfigMode parameter in the specified backup set contains the above information.', 'type' => 'string', 'required' => false, 'example' => '{"whitelist":true,"config":true,"account":true}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The object.'."\n", 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => 'The ID of the VPC.'."\n", 'type' => 'string', 'example' => 'vpc-bp1nme44gek34slfc****', ], 'QPS' => [ 'description' => 'The expected maximum queries per second (QPS).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100000', ], 'Capacity' => [ 'description' => 'The storage capacity of the instance. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16384', ], 'ConnectionDomain' => [ 'description' => 'The internal endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', ], 'ChargeType' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **PrePaid**: subscription'."\n" .'* **PostPaid**: pay-as-you-go'."\n", 'type' => 'string', 'example' => 'PostPaid', ], 'NetworkType' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **CLASSIC**: classic network'."\n" .'* **VPC**: VPC'."\n", 'type' => 'string', 'example' => 'VPC', ], 'InstanceId' => [ 'description' => 'The GUID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'Port' => [ 'description' => 'The port number that is used to connect to the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6379', ], 'Config' => [ 'description' => 'The configurations of the instance.'."\n", '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}', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hongkong', ], 'EndTime' => [ 'description' => 'The time when the subscription 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", 'type' => 'string', 'example' => '2019-01-18T16:00:00Z', ], 'VSwitchId' => [ 'description' => 'The ID of the vSwitch to which the instance is connected.'."\n", 'type' => 'string', 'example' => 'vsw-bp1e7clcw529l773d****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5DEA3CC9-F81D-4387-8E97-CEA40F09****', ], 'NodeType' => [ 'description' => 'The node type. Valid values:'."\n" ."\n" .'* **STAND_ALONE**: standalone'."\n" .'* **MASTER_SLAVE**: master-replica'."\n", 'type' => 'string', 'example' => 'MASTER_SLAVE', ], 'Connections' => [ 'description' => 'The maximum number of connections supported by the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000', ], 'Bandwidth' => [ 'description' => 'The maximum bandwidth of the instance. Unit: MB/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '32', ], 'InstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'apitest', ], 'ZoneId' => [ 'description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b', ], 'InstanceStatus' => [ 'description' => 'The state of the instance. The return value is Creating.'."\n", 'type' => 'string', 'example' => 'Creating', ], 'PrivateIpAddr' => [ 'description' => 'The private IP address of the instance.'."\n", 'type' => 'string', 'example' => '172.16.0.10', ], 'UserName' => [ 'description' => 'The username that is used to connect to the instance. By default, Tair (Redis OSS-compatible) provides a username that is named after the instance ID.', 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2084452111111', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ZoneIdNotFound', 'errorMessage' => 'Specify iz not support switch network.', ], [ 'errorCode' => 'InvalidShardInfo.Format', 'errorMessage' => 'Shard total number is out of range.', ], [ 'errorCode' => 'InvalidInstancelevel', 'errorMessage' => 'Specified Instance level dose not match gdc other member instance level.', ], [ 'errorCode' => 'InvalidBackupLogStatus', 'errorMessage' => 'Backup logs are not enabled for the specified source instance.', ], [ 'errorCode' => 'InvalidStatus', 'errorMessage' => '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.', ], [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', ], [ 'errorCode' => 'InvalidToken.Malformed', 'errorMessage' => 'The Specified parameter Token is not valid.', ], [ 'errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter InstanceName is not valid.', ], [ 'errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The Specified parameter Password is not valid.', ], [ 'errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account does not have enough balance.', ], [ 'errorCode' => 'QuotaExceed.AfterpayInstance', 'errorMessage' => 'Living afterpay instances quota exceeded.', ], [ 'errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', ], [ 'errorCode' => 'ResourceNotAvailable', 'errorMessage' => 'Resource you requested is not available for finance user.', ], [ 'errorCode' => 'PaymentMethodNotFound', 'errorMessage' => 'No payment method has been registered on the account.', ], [ 'errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Request uses a client token in a previous request but is not identical to that request.', ], [ 'errorCode' => 'QuotaNotEnough', 'errorMessage' => 'Quota not enough in this zone.', ], [ 'errorCode' => 'QuotaExceed', 'errorMessage' => 'Living afterpay instances quota exceed.', ], [ 'errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke vpc service failed.', ], [ 'errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify iz not support vpc.', ], [ 'errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The vpc does not cover the vswitch.', ], [ 'errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'The Specified vpc zone not supported.', ], [ 'errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', ], [ 'errorCode' => 'InstanceClass.NotMatch', 'errorMessage' => 'Current instance class and instance type is not match.', ], [ 'errorCode' => 'InvalidVPCId.NotFound', 'errorMessage' => 'Specified virtual vpc is not found.', ], [ 'errorCode' => 'AccountMoneyValidateError', 'errorMessage' => 'Account money validate error.', ], [ 'errorCode' => 'RequestTokenConflict', 'errorMessage' => 'Specified request token conflict.', ], [ 'errorCode' => 'InvalidIPNotInSubnet', 'errorMessage' => 'Error ip not in subnet.', ], [ 'errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', ], [ 'errorCode' => 'Zone.Closed', 'errorMessage' => 'The specified zone is closed.', ], [ 'errorCode' => 'VSwithNotBelongToNotVpcFault', 'errorMessage' => 'The vSwitch does not belong to current vpc.', ], [ 'errorCode' => 'PayIllegalAgreement', 'errorMessage' => 'Pay mayi with holding agreement illegal.', ], [ 'errorCode' => 'IllegalParamError', 'errorMessage' => 'validateSaleConditionWithSubArticle failed.', ], [ '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.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], [ 'errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', ], [ 'errorCode' => 'ResourceGroupNotExist', 'errorMessage' => 'The Specified ResourceGroupId does not exist.', ], ], 403 => [ [ 'errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'Your account has not passed the real-name authentication yet.', ], [ 'errorCode' => 'AuthorizationFailure', 'errorMessage' => 'The request processing has failed due to authorization failure.', ], [ 'errorCode' => 'TokenServiceError', 'errorMessage' => 'The specified token is duplicated, please change it.', ], ], [ [ 'errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', ], [ 'errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The Specified vSwitchId zone not supported.', ], [ 'errorCode' => 'InvalidVpcIdOrVswitchId.NotSupported', 'errorMessage' => 'The Specified vpcId or vSwitchId not supported.', ], ], ], '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"}]', 'title' => 'CreateInstance', 'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](~~54532~~) of Tair (Redis OSS-compatible).'."\n" ."\n" .'You can call this operation to create a Tair (Redis OSS-compatible) instance or a classic Tair DRAM-based instance. To create a cloud-native Tair instance, call the [CreateTairInstance](~~473770~~) operation.'."\n" ."\n" .'> For more information about how to create an instance that meets your requirements in the Tair (Redis OSS-compatible) console, see [Step 1: Create an instance](~~26351~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The business information. This is an additional parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '000000000', ], ], [ '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', ], ], [ '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', ], ], [ '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B79C1A90-495B-4E99-A2AA-A4DB13B8****', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20741011111111', ], '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', ], ], ], ], ], ], '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', 'description' => 'This operation is available only for cluster instances that use cloud disks.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateGlobalDistributeCache' => [ 'summary' => 'Converts an existing Tair DRAM-based classic instance to the first child 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 existing instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n" ."\n" .'> You do not need to specify system parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when you want to perform the conversion. Valid values:'."\n" ."\n" .'* **Immediately**: immediately performs the conversion.'."\n" .'* **MaintainTime** (default): performs the conversion 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' => 'MaintainTime', 'enum' => [ 'Immediately', 'MaintainTime', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E681E498-5A0D-44F2-B1A7-912DC3******', ], 'GlobalInstanceId' => [ 'type' => 'string', ], 'InstanceId' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E681E498-5A0D-44F2-B1A7-912DC3******\\",\\n \\"GlobalInstanceId\\": \\"gr-8vbzg1y6m****t38p\\",\\n \\"InstanceId\\": \\"r-8vb6ffc5****4ec4\\"\\n}","type":"json"}]', 'title' => 'CreateGlobalDistributeCache', 'description' => 'You can call this operation to convert an existing instance to the first child instance of a distributed instance. After the instance is converted, the distributed instance is created. Before you call this operation, make sure that the following requirements are met:'."\n" ."\n" .'* The instance that you want to convert must be a Tair [DRAM-based](~~126164~~) instance that uses the classic deployment mode.'."\n" .'* If the existing instance is a cluster instance, the direct connection mode must be disabled for the instance. For more information, see [Release a private endpoint](~~150047~~).'."\n" ."\n" .'> You can also call the [CreateInstance](~~473757~~) operation to create an instance that is specified as the first child instance of a distributed instance. After the child instance is created, the distributed instance to which the child instance belongs is created.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ '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.'."\n", 'type' => 'string', 'deprecated' => true, 'required' => false, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****-db-0,r-bp1zxszhcgatnx****-db-1', ], ], [ '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.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '4096', 'minimum' => '1', 'example' => '1', ], ], [ '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', ], ], [ '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" .'* **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', 'required' => false, 'example' => 'Immediately', 'default' => '0', 'enum' => [ '0', '1', 'Immediately', 'MaintainTime', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], '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.'."\n", 'type' => 'string', 'example' => '22179******0904', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\",\\n \\"OrderId\\": \\"22179******0904\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t5D622714-AEDD-4609-9167-F5DDD3D1****\\r\\n","errorExample":""}]', 'title' => 'DeleteShardingNode', 'description' => 'You can also remove data shards from an instance in the Tair (Redis OSS-compatible) console. For more information, see [Adjust the number of shards for an instance with cloud disks](~~198082~~).\\'."\n" .'Before you call this operation, make sure that the instance meets the following requirements:'."\n" ."\n" .'* The instance is a persistent memory-optimized instance in the cluster architecture. For more information about persistent memory-optimized instances, see [Persistent memory-optimized instances](~~183956~~).'."\n" .'* The instance has more than one data shard.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D190D2', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'InstanceReleaseProtection', 'errorMessage' => 'The operation is not permitted due to instance release protection.', ], ], ], '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' => ' ', ], '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '870422DE-B64C-5A15-9C48-4A9485D1****', ], ], 'description' => '', ], ], ], '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", ], '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', ], ], [ '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****', ], ], [ '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', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the promotional event or the business information.'."\n", 'type' => 'string', 'required' => false, 'example' => '000000001', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], [ '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', ], ], ], [ '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], [ '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', ], ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '20722623431****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0DA1D7EF-C80D-432C-8758-7D225182626B', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'PaymentMethodNotFound', 'errorMessage' => 'No payment method has been registered on the account.', ], [ 'errorCode' => 'HasRenewChangeOrder', 'errorMessage' => 'This instance has a renewChange order.', ], [ 'errorCode' => '%s', 'errorMessage' => 'Warn: {%s} are not supported after upgraded. you can set forceUpgrade=true to force upgrade.', ], [ 'errorCode' => 'GdcInstanceNotSupport', 'errorMessage' => 'The gdc custins trans not support.', ], [ 'errorCode' => 'AbnormalResourceStatusForRenew', 'errorMessage' => 'Abnormal resource status for renew.', ], [ 'errorCode' => 'MissingRedisShardingUnsupportPerfItem', 'errorMessage' => 'The metadb is missing redis sharding unsupoort command perf item.', ], [ 'errorCode' => 'IllegalParamError', 'errorMessage' => 'Action or resource must not be null.', ], [ 'errorCode' => 'IncorrectTargetMajorVersion', 'errorMessage' => 'Current target majorversion does not support this operation.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'DirectTargetLevelNotSupport', 'errorMessage' => 'The direct custins tranfer target instance level does not support.', ], [ 'errorCode' => 'DirectTransPreCheckError', 'errorMessage' => 'The direct custins trans pre check IsAddReduceNodes error.', ], [ 'errorCode' => 'DtsOpendNotSupportTrans', 'errorMessage' => 'The custins DtsSyncStatus opend does not support trans.', ], [ 'errorCode' => 'DirectTransNodeDoubleLevelError', 'errorMessage' => 'The direct custins tranfer node double target level error.', ], [ 'errorCode' => 'DirectTransUpgradeMajorVersionNotSupport', 'errorMessage' => 'The direct custins tranfer does not support upgrade major version.', ], ], 403 => [ [ 'errorCode' => 'TargetMemoryLessThanCurrentUsed', 'errorMessage' => 'The target instance memory size below the current instance used memory.', ], ], ], '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' => ' ', ], '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AD425AD3-CC7B-4EE2-A5CB-2F61BA73****', ], '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', ], 'LocalName' => [ 'description' => 'The name of the region.'."\n", 'type' => 'string', 'example' => 'China (Hangzhou)'."\n", ], 'RegionId' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ZoneIds' => [ 'description' => 'The IDs of the zones in the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', ], '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', ], ], ], ], ], ], ], ], ], ], 'description' => '', ], ], ], '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":" \\n \\n \\n cn-hangzhou \\n \\n cn-hangzhou-h \\n cn-hangzhou-MAZ10(h,i) \\n cn-hangzhou-MAZ9(g,h) \\n cn-hangzhou-b \\n cn-hangzhou-d \\n cn-hangzhou-e \\n cn-hangzhou-MAZ6(b,f) \\n cn-hangzhou-f \\n cn-hangzhou-g \\n \\n r-kvstore.aliyuncs.com \\n cn-hangzhou-h,cn-hangzhou-MAZ10(h,i),cn-hangzhou-MAZ9(g,h),cn-hangzhou-b,cn-hangzhou-d,cn-hangzhou-e,cn-hangzhou-MAZ6(b,f),cn-hangzhou-f,cn-hangzhou-g \\n 华东1（杭州） \\n \\n \\n AD425AD3-CC7B-4EE2-A5CB-2F61BA73**** \\n\\n","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' => ' ', ], '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1D42F072-72FE-4DC4-BB8E-64B1D298****', ], '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', ], 'ZoneId' => [ 'description' => 'The ID of the zone within the specified region.'."\n", 'type' => 'string', 'example' => 'cn-huhehaote-b', ], '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', ], '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', ], 'ZoneName' => [ 'description' => 'The name of the zone within the specified region.'."\n", 'type' => 'string', 'example' => 'Hohhot Zone B'."\n", ], 'RegionId' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-huhehaote', ], ], ], ], ], ], ], 'description' => '', ], ], ], '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":"{\\n \\"RequestId\\": \\"1D42F072-72FE-4DC4-BB8E-64B1D298182E\\",\\n \\"Zones\\": {\\n \\"KVStoreZone\\": [\\n {\\n \\"ZoneName\\": \\"华东 1 多可用区 6\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-MAZ6(b,f)\\"\\n },\\n {\\n \\"ZoneName\\": \\"华东 1 可用区 B\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\"\\n },\\n {\\n \\"ZoneName\\": \\"华东 1 可用区 D\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-d\\"\\n },\\n {\\n \\"ZoneName\\": \\"华东 1 可用区 E\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-e\\"\\n },\\n {\\n \\"ZoneName\\": \\"华东 1 可用区 F\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-f\\"\\n },\\n {\\n \\"ZoneName\\": \\"华东 1 可用区 G\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-g\\"\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"\\n 1D42F072-72FE-4DC4-BB8E-64B1D298****\\n \\n \\n 呼和浩特 可用区B\\n true\\n false\\n cn-huhehaote\\n cn-huhehaote-b\\n true\\n \\n \\n 呼和浩特 可用区A\\n true\\n false\\n cn-huhehaote\\n cn-huhehaote-a\\n true\\n \\n \\n","errorExample":"\\n 1D42F072-72FE-4DC4-BB8E-64B1D298182E\\n \\n \\n 华东 1 多可用区 6\\n cn-hangzhou\\n cn-hangzhou-MAZ6(b,f)\\n \\n \\n 华东 1 可用区 B\\n cn-hangzhou\\n cn-hangzhou-b\\n \\n \\n 华东 1 可用区 D\\n cn-hangzhou\\n cn-hangzhou-d\\n \\n \\n 华东 1 可用区 E\\n cn-hangzhou\\n cn-hangzhou-e\\n \\n \\n 华东 1 可用区 F\\n cn-hangzhou\\n cn-hangzhou-f\\n \\n \\n 华东 1 可用区 G\\n cn-hangzhou\\n cn-hangzhou-g\\n \\n \\n"}]', 'title' => 'DescribeZones', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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', ], ], [ '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', ], ], [ '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', ], ], ], [ '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', ], ], ], [ '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', ], ], ], [ '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' => '', ], ], [ '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '493B7308-D9C2-55F6-B042-0313BD63****', ], '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', ], 'ZoneName' => [ 'description' => 'The name of the zone.'."\n", 'type' => 'string', 'example' => 'Hangzhou Zone H'."\n", ], 'RegionId' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], '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', ], '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', ], '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', ], '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', ], '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', ], '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', ], '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', ], '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' => '16 GB cluster instance with 8 nodes (1,920,000 queries per second and 240,000 connections)'."\n", ], 'Capacity' => [ 'description' => 'The memory size of the instance. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16384', ], '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', ], ], ], ], ], ], ], ], ], ], ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], ], 'IsMainSale' => [ 'description' => 'An internal parameter.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], '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":"\\n 493B7308-D9C2-55F6-B042-0313BD63****\\n \\n \\n 杭州 可用区H\\n cn-hangzhou-h\\n \\n \\n \\n \\n \\n \\n enhanced_performance_type\\n \\n \\n \\n \\n cluster\\n \\n \\n \\n \\n double\\n \\n \\n 16384\\n 16G集群版（8节点）（QPS:1920000 Connections:240000）\\n redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread\\n \\n \\n 32768\\n 32G集群版（8节点）（QPS:1920000 Connections:240000）\\n redis.amber.logic.sharding.4g.8db.0rodb.24proxy.multithread\\n \\n \\n 65536\\n 64G集群版（8节点）（QPS:1920000 Connections:240000）\\n redis.amber.logic.sharding.8g.8db.0rodb.24proxy.multithread\\n \\n \\n \\n \\n 8\\n \\n \\n \\n \\n 5.0\\n \\n \\n \\n \\n Enterprise\\n \\n \\n redis\\n \\n \\n \\n \\n","errorExample":""}]', 'title' => 'DescribeAvailableResource', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'TransformToPrePaid' => [ 'summary' => 'Changes a pay-as-you-go Tair (Redis OSS-compatible) instance to a subscription instance.', '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 ID of the instance. You can call the [DescribeInstances](~~DescribeInstances~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance. Unit: months. Valid values: **1** to **9**, **12**, **24**, and **36**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal. Default value: false. Valid values:'."\n" ."\n" .'* **true**: enables auto-renewal.'."\n" .'* **false**: disables auto-renewal. In this case, you can renew your instance in the console. For more information, see [Manually renew an instance](~~26352~~).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'* *true*: enables auto-renewal.'."\n" .'* *false* (default): disables auto-renewal.', 'type' => 'string', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration that is supported by auto-renewal. Unit: month. Valid values: **1**, **2**, **3**, **6**, and **12**.'."\n" ."\n" .'> This parameter is required if the **AutoRenew** parameter is set to **true**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'default' => '1', 'enum' => [ '1', ], ], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'default', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => 'The time when the instance expires after the billing method of the instance is changed from pay-as-you-go to subscription.'."\n", 'type' => 'string', 'example' => '2019-01-18T16:00:00Z', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '426F1356-B6EF-4DAD-A1C3-DE53B9DAF586', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '111111111111111', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Period is invalid', ], [ 'errorCode' => 'ResourceNotAvailable', 'errorMessage' => 'Resource you requested is not available for finance user.', ], [ 'errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account does not have enough balance.', ], [ 'errorCode' => 'Order.LatestOrderIsHanding', 'errorMessage' => 'Latest order is handing, please retry later.', ], ], 403 => [ [ 'errorCode' => 'AlreadyPrePaid', 'errorMessage' => 'This instance is already prepaid', ], [ 'errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'Your account has not passed the real-name authentication yet.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2019-01-18T16:00:00Z\\",\\n \\"RequestId\\": \\"426F1356-B6EF-4DAD-A1C3-DE53B9DAF586\\",\\n \\"OrderId\\": \\"111111111111111\\"\\n}","errorExample":"{\\n \\"OrderId\\":\\"202636204910941\\",\\n \\"RequestId\\":\\"426F1356-B6EF-4DAD-A1C3-DE53B9DAF586\\",\\n \\"EndTime\\":\\"2019-01-18T16:00:00Z\\"\\n}"},{"type":"xml","example":"\\n 111111111111111\\n 426F1356-B6EF-4DAD-A1C3-DE53B9DAF586\\n 2019-01-18T16:00:00Z\\n","errorExample":"\\n 202636204910941\\n 426F1356-B6EF-4DAD-A1C3-DE53B9DAF586\\n 2019-01-18T16:00:00Z\\n"}]', 'title' => 'TransformToPrePaid', 'description' => 'For more information about how to change the billing method in the Tair (Redis OSS-compatible) console, see [Switch to subscription](~~54542~~).'."\n" ."\n" .'> You cannot change the billing method of a Tair (Redis OSS-compatible) instance from subscription to pay-as-you-go.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '29B0BF34-D069-4495-92C7-FA6D9452****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NetworkType.NotSupport', 'errorMessage' => 'Specified network type does not support this operation.', ], [ 'errorCode' => 'InstanceStatus.NotSupport', 'errorMessage' => 'Instance status does not support this operation.', ], [ 'errorCode' => 'MissingSwitchId', 'errorMessage' => 'VSwitchId is mandatory for this action.', ], [ 'errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify zone not support VPC.', ], [ 'errorCode' => 'InvalidReginAvzNotFound', 'errorMessage' => 'Specified user does not find the region and zone.', ], [ 'errorCode' => 'ClusterNotSupport', 'errorMessage' => 'The Specified cluster does not support.', ], [ 'errorCode' => 'InvalidVSwitchId.Mismatch', 'errorMessage' => 'The Specified vSwitchId does not matched VPC.', ], [ 'errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'The Specified Zone does not supported.', ], ], 404 => [ [ 'errorCode' => 'DBInstanceNotFound', 'errorMessage' => 'Specified instance does not exist.', ], ], 500 => [ [ 'errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke VPC service failed.', ], [ 'errorCode' => 'ZoneMigrationError.StillingRunning', 'errorMessage' => 'Zone migration task is still running.', ], ], ], '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' => ' ', ], 'CreateTairInstance' => [ 'summary' => 'Creates a Tair (Enterprise Edition) cloud-native 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 region ID. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the instance. The name must meet the following requirements:'."\n" ."\n" .'* The name must be 2 to 80 characters in length.'."\n" .'* The name must start with a letter and cannot contain spaces or special characters. Special characters include `@ / : = " < > { [ ] }`'."\n", 'type' => 'string', 'required' => false, 'example' => 'apitest', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => 'The password that is used to connect to the instance. The password must meet the following requirements:'."\n" ."\n" .'* The password must be 8 to 32 characters in length.'."\n" .'* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include `! @ # $ % ^ & * ( ) _ + - =`'."\n", 'type' => 'string', 'required' => false, 'example' => 'Pass!123456', ], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance series. For more information, see the following topics:'."\n" ."\n" .'* [DRAM-based instances](~~2527112~~)'."\n" .'* [Persistent memory-optimized instances](~~2527110~~)'."\n" .'* [ESSD/SSD-based instances](~~2527111~~)'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tair.scm.standard.4m.32d', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the primary zone. You can call the [DescribeRegions](~~473763~~) operation to query the most recent zone list.'."\n" ."\n" .'> You can also set the SecondaryZoneId parameter to specify the secondary zone. The primary and secondary nodes will then be deployed in the specified primary and secondary zones to implement the master-replica zone-disaster recovery architecture. For example, you can set the ZoneId parameter to cn-hangzhou-h and the SecondaryZoneId parameter to cn-hangzhou-g.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou-e', ], ], [ 'name' => 'SecondaryZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the secondary zone. You can call the [DescribeRegions](~~473763~~) operation to query the ID of the secondary zone.'."\n" ."\n" .'> You cannot specify multiple zone IDs or set this parameter to a value that is the same as that of the ZoneId parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **PrePaid** (default): subscription'."\n" .'* **PostPaid**: pay-as-you-go'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'PostPaid' => 'PostPaid', 'PrePaid' => 'PrePaid', ], 'example' => 'PrePaid', 'default' => 'PrePaid', 'enum' => [ 'PrePaid', 'PostPaid', ], ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the VPC. You can call the [DescribeVpcs](~~35739~~) operation to query VPC IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-bp1nme44gek34slfc****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch that belongs to the VPC. You can call the [DescribeVpcs](~~35739~~) operation to query vSwitch IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vsw-bp1e7clcw529l773d****', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration. Valid values: **1**, 2, 3, 4, 5, 6, 7, 8, **9**, **12**, **24**,**36**, and **60**. Unit: month.'."\n" ."\n" .'> This parameter is required only if the **ChargeType** parameter is set to **PrePaid**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the promotional event or the business information.'."\n", 'type' => 'string', 'required' => false, 'example' => '000000000', ], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => [ 'description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'default' => 'default', ], ], [ 'name' => 'SrcDBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'If you want to create an instance based on the backup set of an existing instance, set this parameter to the ID of the source instance.'."\n" ."\n" .'> After you specify the SrcDBInstanceId parameter, use the **BackupId**, **ClusterBackupId** (recommended for cloud-native cluster instances), or **RestoreTime** parameter to specify the backup set or the specific point in time that you want to use to create an instance. The SrcDBInstanceId parameter must be used in combination with one of the preceding three parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'You can set the BackupId parameter to the backup set ID of the source instance. The system uses the data stored in the backup set to create an instance. You can call the [DescribeBackups](~~473823~~) operation to query the backup set ID. If the source instance is a cluster instance, set the BackupId parameter to the backup set IDs of all shards of the source instance, separated by commas (,). Example: "10\\*\\*,11\\*\\*,15\\*\\*".'."\n" ."\n" .'> If your instance is a cloud-native cluster instance, we recommend that you use [DescribeClusterBackupList](~~2679168~~) to query the backup set ID of the cluster instance, such as cb-xx. Then, set the ClusterBackupId request parameter to the backup set ID to clone the cluster instance. This eliminates the need to specify the backup set ID of each shard.'."\n", 'type' => 'string', 'required' => false, 'example' => '11111111', ], ], [ 'name' => 'ClusterBackupId', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is supported for specific new cluster instances. You can query the backup set ID by calling the [DescribeClusterBackupList](~~2679168~~) operation.'."\n" ."\n" .'* If this parameter is supported, you can specify the backup set ID. In this case, you do not need to specify the **BackupId** parameter.'."\n" .'* If this parameter is not supported, set the BackupId parameter to the IDs of backup sets in all shards of the source instance, separated by commas (,). Example: "2158\\*\\*\\*\\*20,2158\\*\\*\\*\\*22".'."\n", 'type' => 'string', 'required' => false, 'example' => 'cb-hyxdof5x9kqb****', ], ], [ 'name' => 'RecoverConfigMode', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to restore the account, kernel parameter, and whitelist information from the original backup set when you create an instance from the specified backup set. For example, if you want to restore the account information, set the parameter to `{"account":true}`.'."\n" ."\n" .'This parameter is empty by default, which indicates that the account, kernel parameter, and whitelist information is not restored from the original backup set.'."\n" ."\n" .'> This parameter applies only to cloud-native cluster instances. The account, kernel parameter, and whitelist information must be stored in the original backup set. You can call the [DescribeBackups](~~473823~~) operation to check whether the RecoverConfigMode configurations in the specified backup set contain the preceding information.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"whitelist":true,"config":true,"account":true}', ], ], [ 'name' => 'PrivateIpAddress', 'in' => 'query', 'schema' => [ 'description' => 'The internal IP address of the instance.'."\n" ."\n" .'> The IP address must be within the CIDR block of the vSwitch to which you want the instance to connect. You can call the [DescribeVSwitches](~~35748~~) operation of VPC to query the CIDR block information.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.16.88.***', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use a coupon. Valid values:'."\n" ."\n" .'* **true**: uses a coupon.'."\n" .'* **false** (default): does not use a coupon.'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', 'default' => 'false', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'* **true**: enables auto-renewal.'."\n" .'* **false** (default): disables auto-renewal.'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', 'default' => 'false', ], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration that is supported by auto-renewal. Unit: month. Valid values: **1**, **2**, **3**, **6**, and **12**.'."\n" ."\n" .'> This parameter is required if the **AutoRenew** parameter is set to **true**.'."\n", 'type' => 'string', 'required' => false, 'example' => '3', 'default' => '1', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group that you want to manage.'."\n" ."\n" .'> '."\n" ."\n" .'* You can query resource group IDs in the console or by calling the [ListResourceGroups](~~158855~~) operation. For more information, see [View the basic information about a resource group](~~151181~~).'."\n" ."\n" .'* Before you modify the resource group to which an instance belongs, you can call the [ListResources](~~158866~~) operation to view the current resource group of the instance.'."\n", 'type' => 'string', 'required' => false, 'maximum' => '4096', 'minimum' => '1', 'example' => 'rg-acfmyiu4ekp****', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic payment. Set the value to **true**.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', 'enum' => [ 'true', ], ], ], [ '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 and is case-sensitive. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ '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" ."\n" .'Enumerated values:'."\n" ."\n" .'* essd_pl0'."\n" .'* essd_pl1'."\n" .'* essd_pl2'."\n" .'* essd_pl3'."\n", 'type' => 'string', 'required' => false, 'example' => 'essd_pl1', 'enum' => [ 'essd_pl0', 'essd_pl1', 'essd_pl2', 'essd_pl3', ], ], ], [ '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', ], ], [ 'name' => 'ShardType', 'in' => 'query', 'schema' => [ 'description' => 'The shard type of the instance. Valid values:'."\n" ."\n" .'* **MASTER_SLAVE** (default): runs in a master-replica architecture that provides high availability.'."\n" .'* **STAND_ALONE**: runs in a standalone architecture. If the only node fails, the system creates a new instance and switches the workloads to the new instance. This may cause data loss. You can set the ShardType parameter to this value only if the instance uses the **single-zone** deployment mode. If you set the ShardType parameter to this value, you cannot create cluster or read/write splitting instances.'."\n", 'type' => 'string', 'required' => false, 'example' => 'MASTER_SLAVE', 'default' => 'MASTER_SLAVE', 'enum' => [ 'STAND_ALONE', 'MASTER_SLAVE', ], ], ], [ 'name' => 'ShardCount', 'in' => 'query', 'schema' => [ 'description' => 'The number of data nodes in the instance. Valid values:'."\n" ."\n" .'* **1** (default): You can create a [standard instance](~~52228~~) that contains only one data node.'."\n" .'* **2** to **32**: You can create a [cluster instance](~~52228~~) that contains the specified number of data nodes.'."\n" ."\n" .'> When the **InstanceType** parameter is set to **tair_rdb** or **tair_scm**, this parameter can be set to a value in the range of **2** to **32**. Only DRAM-based and persistent memory-optimized instances support the cluster architecture.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '128', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'ReplicaCount', 'in' => 'query', 'schema' => [ 'description' => 'The number of replica nodes in the primary zone. This parameter applies 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 exceed 4.'."\n" ."\n" .'* You can specify only one of the ReplicaCount and ReadOnlyCount parameters.'."\n" ."\n" .'* Master-replica instances do not support multiple replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '2', ], ], [ '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 deployed across multiple zones. The sum of the values of this parameter and the ReplicaCount parameter cannot exceed 4.'."\n" ."\n" .'> When you create a cloud-native multi-replica cluster instance deployed across multiple zones, you must specify both SlaveReplicaCount and SecondaryZoneId.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '2', ], ], [ 'name' => 'ReadOnlyCount', 'in' => 'query', 'schema' => [ 'description' => 'The number of read replicas in the primary zone. This parameter applies only to cloud-native read/write splitting instances. Valid values: 1 to 9.'."\n" ."\n" .'> The sum of the values of this parameter and the SlaveReadOnlyCount parameter cannot exceed 9.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '5', 'minimum' => '1', 'example' => '5', ], ], [ 'name' => 'SlaveReadOnlyCount', 'in' => 'query', 'schema' => [ 'description' => 'The number of read replicas in the secondary zone when you create a multi-zone read/write splitting instance. The sum of the values of this parameter and the ReadOnlyCount parameter cannot exceed 9.'."\n" ."\n" .'> When you create a multi-zone read/write splitting instance, you must specify both SlaveReadOnlyCount and SecondaryZoneId.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '0', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version. Default value: **1.0**. The parameter value varies based on the Tair instance series.'."\n" ."\n" .'* To create a Tair DRAM-based instance (Tair_rdb) that is compatible with Redis 5.0, 6.0, or 7.0, set this parameter to **5.0**, **6.0**, or **7.0**.'."\n" .'* To create a Tair persistent memory-optimized instance (tair_scm) that is compatible with Redis 6.0, set this parameter to **1.0**.'."\n" .'* To create a Tair ESSD-based instance (tair_essd) that is compatible with Redis 6.0, set this parameter to **1.0**. To create a Tair SSD-based instance that is compatible with Redis 6.0, set this parameter to **2.0**.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.0', 'default' => '1.0', 'enum' => [ '1.0', '5.0', '6.0', '2.0', '7.0', ], ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The instance series. Valid values:'."\n" ."\n" .'* **tair_rdb**: Tair DRAM-based instance'."\n" .'* **tair_scm**: Tair persistent memory-optimized instance'."\n" .'* **tair_essd**: Tair ESSD/SSD-based instance'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tair_scm', 'enum' => [ 'tair_scm', 'tair_essd', 'tair_rdb', 'Redis', 'tair_skv', ], ], ], [ 'name' => 'GlobalInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use the created instance as a child instance of a distributed instance.'."\n" ."\n" .'* If you want the created instance to be used as the first child instance, enter **true**.'."\n" .'* If you want the created instance to be used as the second or third child instance, enter the ID of the distributed instance, such as gr-bp14rkqrhac\\*\\*\\*\\*.'."\n" .'* If you do not want the created instance to be used as a distributed instance, leave the parameter empty.'."\n" ."\n" .'> If you want the created instance to be used as a distributed instance, the created instance must be a Tair DRAM-based instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'gr-bp14rkqrhac****', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'Details of the tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the tag.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key. A tag is a key-value pair.'."\n" ."\n" .'> A maximum of five key-value pairs can be specified at a time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key1_test', ], 'Value' => [ 'description' => 'The value of the tag.'."\n" ."\n" .'> **N** specifies the value of the nth tag. For example, **Tag.1.Value** specifies the value of the first tag, and **Tag.2.Value** specifies the value of the second tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value1_test', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n" ."\n" .'* **true**: performs a dry run and does not create the instance. The system prechecks the request parameters, request format, service limits, and available resources. If the request fails the dry run, an error code is returned. If the request passes the precheck, the `DryRunOperation` error code is returned.'."\n" .'* **false** (false): performs a dry run and performs the actual request. If the request passes the dry run, the instance is directly created.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'Port', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The service port number of the instance. Valid values: 1024 to 65535. Default value: 6379.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '65535', 'minimum' => '1024', 'exclusiveMinimum' => false, 'example' => '6379', 'default' => '6379', ], ], [ 'name' => 'GlobalSecurityGroupIds', 'in' => 'query', 'schema' => [ 'description' => 'The global IP whitelist templates of the instance. Separate multiple IP whitelist templates with commas (,). Each IP whitelist template must be unique.'."\n", 'type' => 'string', 'required' => false, 'example' => 'g-zsldxfiwjmti0kcm****', ], ], [ 'name' => 'ParamGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the parameter template. The instance is created based on the parameters in the parameter template. The ID must be unique.'."\n", 'type' => 'string', 'required' => false, 'example' => 'g-50npzjcqb1ua6q6j****', ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'description' => 'If data flashback is enabled for the source instance, you can use this parameter to specify a point in time within the backup retention period of the source instance. The system uses the backup data of the source instance at the point in time to create an instance. 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", 'type' => 'string', 'required' => false, 'example' => '2021-07-06T07:25:57Z', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'description' => 'The prefix of the endpoint. 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" .'> The endpoint must be in the \\.redis.rds.aliyuncs.com format.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'QPS' => [ 'description' => 'The maximum number of read and write operations that can be processed by the instance per second. The value is a theoretical value.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100000', ], 'ConnectionDomain' => [ 'description' => 'The internal endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp13ac3d047b****.tairpena.rds.aliyuncs.com', ], 'ChargeType' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **PrePaid**: subscription'."\n" .'* **PostPaid**: pay-as-you-go'."\n", 'type' => 'string', 'example' => 'PrePaid', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp13ac3d047b****', ], 'Port' => [ 'description' => 'The service port number of the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6379', ], 'Config' => [ 'description' => 'The detailed configurations of the instance. The value is a JSON string. For more information about the parameters, see [Configure parameters](~~43885~~).'."\n", '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}', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '12123216-4B00-4378-BE4B-08005BFC****', ], 'Bandwidth' => [ 'description' => 'The maximum bandwidth of the instance. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '96', ], 'Connections' => [ 'description' => 'The maximum number of connections to the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n" ."\n" .'> This parameter is returned only if the **InstanceName** parameter is specified in the request.'."\n", 'type' => 'string', 'example' => 'redistest', ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', ], 'InstanceStatus' => [ 'description' => 'The current status of the instance. The value is **Creating**.'."\n", 'type' => 'string', 'example' => 'Creating', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '10****', ], 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2084452111111', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', ], [ 'errorCode' => 'InvalidToken.Malformed', 'errorMessage' => 'The Specified parameter Token is not valid.', ], [ 'errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter InstanceName is not valid.', ], [ 'errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The Specified parameter Password is not valid.', ], [ 'errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account does not have enough balance.', ], [ 'errorCode' => 'QuotaExceed.AfterpayInstance', 'errorMessage' => 'Living afterpay instances quota exceeded.', ], [ 'errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', ], [ 'errorCode' => 'ResourceNotAvailable', 'errorMessage' => 'Resource you requested is not available for finance user.', ], [ 'errorCode' => 'PaymentMethodNotFound', 'errorMessage' => 'No payment method has been registered on the account.', ], [ 'errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Request uses a client token in a previous request but is not identical to that request.', ], [ 'errorCode' => 'QuotaNotEnough', 'errorMessage' => 'Quota not enough in this zone.', ], [ 'errorCode' => 'QuotaExceed', 'errorMessage' => 'Living afterpay instances quota exceed.', ], [ 'errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke vpc service failed.', ], [ 'errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify iz not support vpc.', ], [ 'errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The vpc does not cover the vswitch.', ], [ 'errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'The Specified vpc zone not supported.', ], [ 'errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', ], [ 'errorCode' => 'InstanceClass.NotMatch', 'errorMessage' => 'Current instance class and instance type is not match.', ], [ 'errorCode' => 'InvalidVPCId.NotFound', 'errorMessage' => 'Specified virtual vpc is not found.', ], [ 'errorCode' => 'AccountMoneyValidateError', 'errorMessage' => 'Account money validate error.', ], [ 'errorCode' => 'RequestTokenConflict', 'errorMessage' => 'Specified request token conflict.', ], [ 'errorCode' => 'InvalidIPNotInSubnet', 'errorMessage' => 'Error ip not in subnet.', ], [ 'errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', ], [ 'errorCode' => 'Zone.Closed', 'errorMessage' => 'The specified zone is closed.', ], [ 'errorCode' => 'VSwithNotBelongToNotVpcFault', 'errorMessage' => 'The vSwitch does not belong to current vpc.', ], [ 'errorCode' => 'PayIllegalAgreement', 'errorMessage' => 'Pay mayi with holding agreement illegal.', ], [ 'errorCode' => 'IllegalParamError', 'errorMessage' => 'validateSaleConditionWithSubArticle failed.', ], [ '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.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], ], 403 => [ [ 'errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'Your account has not passed the real-name authentication yet.', ], [ 'errorCode' => 'AuthorizationFailure', 'errorMessage' => 'The request processing has failed due to authorization failure.', ], [ 'errorCode' => 'TokenServiceError', 'errorMessage' => 'The specified token is duplicated, please change it.', ], [ 'errorCode' => 'UserCannotBuyNotInnerCommodity', 'errorMessage' => 'The user can not buy this commodity without alibaba group tag.', ], ], [ [ 'errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', ], [ 'errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The Specified vSwitchId zone not supported.', ], [ 'errorCode' => 'InvalidVpcIdOrVswitchId.NotSupported', 'errorMessage' => 'The Specified vpcId or vSwitchId not supported.', ], ], ], 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\r\\n 10000\\r\\n 10****\\r\\n F371C892-2143-4640-810E-74553F37****\\r\\n cn-hangzhou-h\\r\\n r-bp13ac3d047b****\\r\\n {\\"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}\\r\\n 6379\\r\\n redistest\\r\\n r-bp13ac3d047b****.tairpena.rds.aliyuncs.com\\r\\n 100000\\r\\n Creating\\r\\n PrePaid\\r\\n 96\\r\\n cn-hangzhou\\r\\n","errorExample":""}]', 'title' => 'CreateTairInstance', 'description' => 'For information about instance selection, see [Instructions for selecting an appropriate Tair (Redis OSS-compatible) instance](~~223808~~).'."\n" ."\n" .'Before you call this operation, make sure that you understand the billing methods and [pricing](~~54532~~) of Tair (Redis OSS-compatible).'."\n" ."\n" .'> '."\n" ."\n" .'* For information about how to create an instance in the console, see [Step 1: Create an instance](~~26351~~).'."\n" ."\n" .'* To create other types of instances, such as Redis Open-Source Edition instances or [Tair DRAM-based](~~126164~~) instances, you can call the [CreateInstance](~~473757~~) operation.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'translator' => 'machine', ], 'CreateInstances' => [ 'summary' => 'Creates multiple Tair (Redis OSS-compatible) instances at a time.', '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 JSON-formatted configurations of the instance. For more information, see the "Additional description of the Instances parameter" section.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{ "RegionId": "cn-hangzhou", "izNo": "cn-hangzhou-b", "quantity": 2, "instanceType": "Redis", "instanceClass": "redis.master.small.default", "EngineVersion": "5.0", "ChargeType": "PostPaid"}]', ], ], [ 'name' => 'Token', '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' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic payment. Valid values:'."\n" ."\n" .'* **true** (default).'."\n" .'* **false**. 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.'."\n" ."\n" .'> This parameter is valid only if the value of the **ChargeType** field in the **Instances** parameter is set to **PrePaid**.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The additional business information about the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '000000000', ], ], [ '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', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance. Valid values: **4.0** and **5.0**.'."\n" ."\n" .'> The default value is **5.0**.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* 2.8'."\n" .'* 4.0'."\n" .'* 5.0'."\n", 'type' => 'string', 'required' => false, 'example' => '5.0', 'default' => '2.8', 'enum' => [ '2.8', '4.0', '5.0', ], ], ], [ 'name' => 'RebuildInstance', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to restore the source instance from the recycle bin. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false** (default)'."\n" ."\n" .'> This parameter is valid only if the **SrcDBInstanceId** field in the **Instances** parameter is specified.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values:'."\n" ."\n" .'* **true**: yes'."\n" .'* **false**: no'."\n" ."\n" .'> This parameter is available only if **ChargeType** in the **Instances** parameter is set to **PrePaid**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group to which to assign the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-resourcegroupid1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '20905403119****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****', ], 'InstanceIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'InstanceId' => [ 'description' => 'The IDs of instances that were created.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'r-bp16e70a4338****', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Zone.Closed', 'errorMessage' => 'Specified zone is closed.', ], [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', ], [ 'errorCode' => 'InvalidToken.Malformed', 'errorMessage' => 'The Specified parameter "Token" is not valid.', ], [ 'errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter "InstanceName" is not valid.', ], [ 'errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The Specified parameter "Password" is not valid.', ], [ 'errorCode' => 'InvalidInstances.Malformed', 'errorMessage' => 'The Specified parameter "Instances" is not valid.', ], [ 'errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account does not have enough balance.', ], [ 'errorCode' => 'QuotaExceed.AfterpayInstance', 'errorMessage' => 'Living afterpay instances quota exceeded.', ], [ 'errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', ], [ 'errorCode' => 'ResourceNotAvailable', 'errorMessage' => 'Resource you requested is not available for finance user.', ], [ 'errorCode' => 'PaymentMethodNotFound', 'errorMessage' => 'No payment method has been registered on the account.', ], [ 'errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Request uses a client token in a previous request but is not identical to that request.', ], [ 'errorCode' => 'QuotaNotEnough', 'errorMessage' => 'Quota not enough in this zone.', ], [ 'errorCode' => 'QuotaExceed', 'errorMessage' => 'Living afterpay instances quota exceed.', ], [ 'errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke vpc service failed.', ], [ 'errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify iz not support vpc.', ], [ 'errorCode' => 'InvalidVpcIdRegion.NotSupported', 'errorMessage' => 'The Specified vpcId or vSwitchId not supported.', ], [ 'errorCode' => 'ResourceGroupNotExist', 'errorMessage' => 'The Specified ResourceGroupId does not exist. ', ], ], 403 => [ [ 'errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'Your account has not passed the real-name authentication yet.', ], ], [ [ 'errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', ], ], ], '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' => 'CreateInstances', 'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](~~54532~~) of Tair (Redis OSS-compatible).'."\n" ."\n" .'> You can call this operation to create classic Redis Open-Source Edition instances or classic Tair DRAM-based instances. We recommend that you use an API operation for creating a single instance:'."\n" ."\n" .'* [CreateInstance](~~473757~~): creates a Redis Open-Source instance or a classic Tair DRAM-based instance.'."\n" ."\n" .'* [CreateTairInstance](~~473770~~): creates a Tair (Enterprise Edition) instance. The instance can be a DRAM-based, persistent memory-optimized, or ESSD/SSD-based instance.', 'requestParamsDescription' => '### Additional description of the Instances parameter'."\n" ."\n" .'|Parameter|Type|Required|Example|Description|'."\n" .'|---|---|---|---|---|'."\n" .'|RegionId|String|Yes|cn-hangzhou|The region ID. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.|'."\n" .'|IzNo|String|Yes|cn-hangzhou-b|The ID of the primary zone. You can call the [DescribeRegions](~~473763~~) operation to query the most recent zone list.|'."\n" .'|Quantity|Integer|No|1|The number of instances that you want to create. Valid values: **1** to **300**. Default value: **1**.|'."\n" .'|InstanceType|String|No|Redis|The database engine of the instance. Valid values:|'."\n" .'|InstanceClass|String|No|redis.master.small.default|The instance type. For example, redis.master.small.default indicates a Community Edition standard master-replica instance that has 1 GB of memory. For more information, see [Overview](~~26350~~).**Note** You must specify this parameter or **Capacity**.|'."\n" .'|Capacity|Long|No|16384|The storage capacity of the instance. Unit: MB. For more information, see [Overview](~~26350~~).**Note** You must specify this parameter or **InstanceClass**.|'."\n" .'|EngineVersion|String|No|5.0|The major version of the instance. Valid values:|'."\n" .'|ChargeType|String|No|PrePaid|The billing method of the instance. Valid values:|'."\n" .'|Period|Long|No|12|The subscription duration. Valid values: **1**, 2, 3, 4, 5, 6, 7, 8, **9**, **12**, **24**,**36**, and **60**. Unit: month.**Note** This parameter is valid and required only if you set **ChargeType** to **PrePaid**.|'."\n" .'|AutoRenew|String|No|true|Specifies whether to enable auto-renewal for the instance. Valid values:**Note** This parameter is valid only if you set **ChargeType** to **PrePaid**.|'."\n" .'|InstanceName|String|No|apitest|The name of the instance. The name must meet the following requirements:|'."\n" .'|Password|String|No|Pass!123456|The password that is used to connect to the instance.|'."\n" .'|NetworkType|String|No|VPC|The network type of the instance. Set the value to **VPC**, which is the default value.|'."\n" .'|VpcId|String|No|vpc-bp1nme44gek34slfc\\*\\*\\*\\*|The VPC ID. You can call the [DescribeVpcs](~~35739~~) operation to query the VPC ID.|'."\n" .'|VSwitchId|String|No|vsw-bp1e7clcw529l773d\\*\\*\\*\\*|The ID of the vSwitch that belongs to the VPC. You can call the [DescribeVpcs](~~35739~~) operation to query the vSwitch ID.|'."\n" .'|NodeType|String|No|MASTER\\_SLAVE|The node type of the instance. Valid values:|'."\n" .'|SrcDBInstanceId|String|No|r-bp1zxszhcgatnx\\*\\*\\*\\*|The ID of the source instance. You can call the [DescribeInstances](~~473778~~) operation to query the instance ID.**Note** This parameter is required only if you want to create an instance from the backup set of the specified instance.|'."\n" .'|BackupId|String|No|111111111|The ID of the backup set. You can call the [DescribeBackups](~~473823~~) operation to query the backup set ID.**Note** If you want to create an instance from the backup set of a specified instance, you must specify the source instance in **SrcDBInstanceId**. You must also specify the ID of the backup set that was created based on the source instance. Then, the system creates an instance based on the specified backup set.|'."\n" .'|RebuildInstance|String|No|false|Specifies whether to recover the source instance from the recycle bin. Valid values:**Note** If you specify this parameter, you must also specify **SrcDBInstanceId**.|'."\n" ."\n" .'### Sample requests with Instances configured'."\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' => ' ', ], 'EnableAdditionalBandwidth' => [ 'summary' => 'Adjusts the bandwidth of a Tair (Redis OSS-compatible) instance. Only the pay-as-you-go billing method is supported for bandwidth adjustment. You need to specify 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 ID of the instance. You can call the [DescribeInstances](~~473778~~) operation to query the IDs of instances.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => [ 'description' => 'The coupon ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'default' => 'youhuiquan_promotion_option_id_for_blank', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic payment. Default value: true. Valid values:'."\n" ."\n" .'* **true**: enables automatic payment. Make sure that you have sufficient balance within your account.'."\n" .'* **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', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the data shard for which you want to purchase a specific amount of bandwidth. You can call the [DescribeLogicInstanceTopology](~~473786~~) operation to query the IDs of the data shards in an instance. If you specify multiple data shard IDs, separate the data shard IDs with commas (,). You can also set this parameter to **All**, which specifies all the data shards of the instance.'."\n" ."\n" .'> This parameter is valid and required only if the instance is a [cluster](~~52228~~) instance or [read/write splitting](~~62870~~) instance.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'r-bp1zxszhcgatnx****-db-0', 'default' => '', ], ], [ 'name' => 'Bandwidth', 'in' => 'query', 'schema' => [ 'description' => 'The amount of extra bandwidth that you want to purchase. Unit: Mbit/s. The value must be an integer greater than or equal to **0**. The maximum value can be up to six times the default bandwidth of the instance or a single shard, but cannot exceed 192 Mbit/s. For example, if the default bandwidth of an instance is 10 Mbit/s, the value range of this parameter is **0** to **60**.'."\n" ."\n" .'> * You can call the [DescribeRoleZoneInfo](~~473782~~) operation to obtain the default maximum bandwidth returned by the **DefaultBandWidth** response parameter. For more information about instance types, see [Overview](~~26350~~).'."\n" .'> - If you specify multiple data shard IDs in the **NodeId** parameter, you must specify the amount of bandwidth that you want to purchase for each specified data shard in the Bandwidth parameter. The bandwidth values that you specify in the Bandwidth parameter must be in the same sequence as the data shard IDs that you specify in the NodeId parameter. In addition, you must separate the bandwidth values with commas (,).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '20', ], ], [ 'name' => 'OrderTimeLength', 'in' => 'query', 'schema' => [ 'description' => 'The validity period of the bandwidth that you purchase. Unit: day. Valid values: **1**, **2**, **3**, **7**, **14**, **30**, **60**, **90**, **180**, **365**, **730**, **1095**, and **1825**.'."\n" ."\n" .'> If you want to continue using the purchased bandwidth after the specified period of time elapses, you must call the [RenewAdditionalBandwidth](~~473804~~) operation to submit a renewal order.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '30', 'default' => '1', ], ], [ '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', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" ."\n" .'* **true**: enables auto-renewal.'."\n" .'* **false**: disables auto-renewal. This is the default value.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The auto-renewal cycle based on which Tair (Redis OSS-compatible) automatically renews the purchased bandwidth. Unit: months. Valid values: **1**, **2**, **3**, **4**, **5**, **6**, **7**, **8**, **9**, **12**, **24**, **36**, and **60**.'."\n" ."\n" .'> * This parameter takes effect and must be specified only when you set the **AutoRenew** parameter to **true**.'."\n" .'> * You cannot query the auto-renewal cycle by calling an API operation. To obtain the auto-renewal cycle, you can perform the following procedure: In the top navigation bar of the Tair (Redis OSS-compatible) console, choose **Expenses** > **Renewal Management**. On the page that appears, enter the ID of the instance and the `-bw` suffix in the **Instance ID** field. Example: r-bp1zxszhcgatnx****-bw.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the bandwidth instance. Default value: PostPaid. Valid values:'."\n" ."\n" .'- PrePaid: subscription'."\n" .'- PostPaid: pay-as-you-go', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'PostPaid', 'enum' => [ 'PostPaid', 'PrePaid', ], ], ], [ 'name' => 'BandWidthBurst', 'in' => 'query', 'schema' => [ 'type' => 'boolean', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '2084452111111', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"2084452111111\\",\\n \\"RequestId\\": \\"D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D622714-AEDD-4609-9167-F5DDD3D1****\\n 2084452111111\\n\\n","errorExample":""}]', 'title' => 'EnableAdditionalBandwidth', 'description' => 'If you enable the bandwidth auto scaling feature and call this operation at the same time, bandwidth auto scaling takes precedence. During bandwidth scale-back, the instance is scaled back to the default bandwidth of the instance type. For more information about the limits, costs, and FAQ about this feature, see [Adjust the bandwidth of an instance](~~102588~~).'."\n" ."\n" .'> Before you call this operation, you can call the [DescribeRoleZoneInfo](~~473782~~) operation to query the current bandwidth of each data node in an instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'InstanceName or NewPassword at least one is mandatory for this action.', ], [ 'errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter InstanceName is not valid.', ], [ 'errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The Specified parameter NewPassword is not valid.', ], [ 'errorCode' => 'TaskExists', 'errorMessage' => 'Specified task have existed.', ], ], ], '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"}]', 'title' => 'ModifyInstanceAttribute', '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~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ '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****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ResourceGroupId.InValid', 'errorMessage' => 'The Specified resource group id is not found.', ], ], 403 => [ [ 'errorCode' => 'ServiceAccount.NoPermission', 'errorMessage' => 'Service account has no auth to do this action.', ], ], [ [ 'errorCode' => 'EntityNotExists.Resource', 'errorMessage' => 'The resource does not EXIST.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidEndTime.Format', 'errorMessage' => 'Specified end time is not valid.', ], ], ], '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"}]', '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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AA587FB2-2593-4DFE-BE13-2494C2DF****', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'NoQuota', 'errorMessage' => 'Request zone has no quota to sell.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '28761557-0B33-41DF-AEEB-322DFF96****', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'NoQuota', 'errorMessage' => 'Request zone has no quota to sell.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'ID of the request.', 'type' => 'string', 'example' => '2FF6158E-3394-4A90-B634-79C49184****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FF6158E-3394-4A90-B634-79C49184****\\"\\n}","type":"json"}]', 'title' => 'ModifyDBInstanceAutoUpgrade', ], 'DescribeInstancesOverview' => [ 'summary' => 'Queries the overview information of one or more 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' => '103727', 'abilityTreeNodes' => [ 'FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the region in which the instances you want to query reside. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of instances.'."\n" ."\n" .'> By default, all instances that belong to this account are queried. If you specify multiple instance IDs, separate the instance IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'InstanceStatus', 'in' => 'query', 'schema' => [ '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 certificate of the instance is being changed.'."\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, see [Instance states and impacts](~~200740~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Normal', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **PrePaid**: subscription'."\n" .'* **PostPaid**: pay-as-you-go'."\n", 'type' => 'string', 'required' => false, 'example' => 'PostPaid', 'enum' => [ 'PrePaid', 'PostPaid', 'dhgpay', ], ], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **CLASSIC**: classic network'."\n" .'* **VPC**: Virtual Private Cloud (VPC)'."\n", 'type' => 'string', 'required' => false, 'example' => 'CLASSIC', 'enum' => [ 'CLASSIC', 'VPC', ], ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The engine version of the instance. Valid values: **2.8**, **4.0**, **5.0**, **6.0**, and **7.0**.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* 1.0'."\n" .'* 2.8'."\n" .'* 4.0'."\n" .'* 5.0'."\n" .'* 6.0'."\n" .'* 7.0'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ '4.0' => '4.0', '5.0' => '5.0', '6.0' => '6.0', '7.0' => '7.0', '2.8' => '2.8', ], 'example' => '4.0', 'enum' => [ '1.0', '2.8', '4.0', '5.0', '6.0', '7.0', ], ], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the instance. For more information, see [Instance types](~~107984~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'redis.master.small.default', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1nme44gek34slfc****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1e7clcw529l773d****', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The category of the instance. Valid values:'."\n" ."\n" .'* **Tair**'."\n" .'* **Redis**'."\n" .'* **Memcache**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Redis', 'default' => 'Redis', 'enum' => [ 'Redis', 'Memcache', 'tair_essd', 'tair_scm', 'tair_rdb', 'Tair', ], ], ], [ 'name' => 'SearchKey', 'in' => 'query', 'schema' => [ 'description' => 'The keyword used for fuzzy search. The keyword can be based on an instance ID or an instance description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'apitest', ], ], [ 'name' => 'ArchitectureType', 'in' => 'query', 'schema' => [ 'description' => 'The architecture of the instance. Valid values:'."\n" ."\n" .'* **cluster**: cluster architecture'."\n" .'* **standard**: standard architecture'."\n" .'* **rwsplit**: read/write splitting architecture'."\n", 'type' => 'string', 'required' => false, 'example' => 'standard', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group to which the instances you want to query belong.'."\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~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', ], ], [ 'name' => 'EditionType', 'in' => 'query', 'schema' => [ 'description' => 'The edition of the instance. Valid values:'."\n" ."\n" .'* **Community**: Redis Open-Source Edition'."\n" .'* **Enterprise**: Tair (Enterprise Edition)'."\n", 'type' => 'string', 'required' => false, 'example' => 'Enterprise', 'enum' => [ 'Enterprise', 'Community', ], ], ], [ 'name' => 'PrivateIp', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.16.49.***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1E83311F-0EE4-4922-A3BF-730B312B****', ], 'TotalCount' => [ 'description' => 'The total number of instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Instances' => [ 'description' => 'The queried instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The overview information of the instance.'."\n", 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => 'The ID of the VPC.'."\n", 'type' => 'string', 'example' => 'vpc-bp1nme44gek34slfc****', ], 'PrivateIp' => [ 'description' => 'The private IP address of the instance.'."\n" ."\n" .'> This parameter is not returned when the instance is deployed in the classic network.'."\n", 'type' => 'string', 'example' => '172.16.49.***', ], 'Capacity' => [ 'description' => 'The storage capacity of the instance. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4096', ], 'CreateTime' => [ 'description' => 'The time when the instance was created.'."\n", 'type' => 'string', 'example' => '2018-11-07T08:49:00Z', ], 'ConnectionDomain' => [ 'description' => 'The internal endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', ], 'ChargeType' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **PrePaid**: subscription'."\n" .'* **PostPaid**: pay-as-you-go'."\n", 'type' => 'string', 'example' => 'PostPaid', ], 'ArchitectureType' => [ 'description' => 'The architecture of the instance. Valid values:'."\n" ."\n" .'* **cluster**: cluster architecture'."\n" .'* **standard**: standard architecture'."\n" .'* **rwsplit**: read/write splitting architecture'."\n", 'type' => 'string', 'example' => 'cluster', ], 'NetworkType' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **CLASSIC**: classic network'."\n" .'* **VPC**: VPC'."\n", 'type' => 'string', 'example' => 'CLASSIC', ], 'EngineVersion' => [ 'description' => 'The engine version of the instance. Valid values: **2.8**, **4.0**, **5.0**, **6.0**, and **7.0**.'."\n", 'type' => 'string', 'example' => '4.0', ], 'InstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'apitest', ], 'GlobalInstanceId' => [ 'description' => 'The ID of the distributed instance.'."\n" ."\n" .'> This parameter is returned only when the instance is a child instance of a distributed instance.'."\n", 'type' => 'string', 'example' => 'gr-bp14rkqrhac****', ], 'InstanceClass' => [ 'description' => 'The instance type of the instance.'."\n", 'type' => 'string', 'example' => 'redis.logic.sharding.2g.2db.0rodb.4proxy.default', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'InstanceType' => [ 'description' => 'The edition of the instance. Valid values:'."\n" ."\n" .'* **Tair**: Tair (Enterprise Edition)'."\n" .'* **Redis**: Redis Open-Source Edition'."\n" .'* **Memcache**'."\n", 'type' => 'string', 'example' => 'Redis', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'EndTime' => [ 'description' => 'The time when the subscription instance expires.'."\n", 'type' => 'string', 'example' => '2022-06-13T16:00:00Z', ], 'VSwitchId' => [ 'description' => 'The ID of the vSwitch to which the instance is connected.'."\n", 'type' => 'string', 'example' => 'vsw-bp1e7clcw529l773d****', ], 'ResourceGroupId' => [ 'description' => 'The ID of the resource group to which the instance belongs.'."\n", 'type' => 'string', 'example' => 'rg-acfmyiu4ekp****', ], 'ZoneId' => [ 'description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b', ], '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 certificate of the instance is 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', ], 'SecondaryZoneId' => [ 'description' => 'Instance\'s secondary zone id.'."\n" .'> This parameter is only returned when the instance has a secondary zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-g', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidInstanceIds.Malformed', 'errorMessage' => 'The Specified parameter InstanceIds is not valid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","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 \\"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}","errorExample":""},{"type":"xml","example":"\\n \\n cluster\\n 32768\\n PrePaid\\n r-bp1d****letsgv****.tairpena.rds.aliyuncs.com\\n 2021-11-11T06:52:52Z\\n 2021-12-11T16:00:00Z\\n 1.0\\n tair.scm.cluster.sharding.common.ce\\n r-bp1d****letsgv****\\n aep***-pull-cluster\\n Normal\\n tair_scm\\n VPC\\n 172.16.*.*\\n cn-hangzhou\\n rg-acfm22c********\\n vsw-bp1p9le7ibusm********\\n vpc-bp1jk5vwkcri2********\\n cn-hangzhou-h\\n \\n E9848396-E363-5ECE-94D2-E0CF993*****\\n 1\\n","errorExample":""}]', 'title' => 'DescribeInstancesOverview', 'description' => 'If you do not specify the InstanceIds parameter when you call this operation, the overview information of all instances is returned.'."\n" ."\n" .'> This operation returns non-paged results.'."\n", ], 'DescribeInstances' => [ 'summary' => 'Queries the information about one or more Tair (Redis OSS-compatible) instances.', '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 you call this operation and specify the **Tag** parameter, you must also specify this parameter.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of the instances that you want to query.'."\n" ."\n" .'> If you want to specify multiple instance IDs, separate the instance IDs with commas (,). You can specify a maximum of 30 instance IDs in a single request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'InstanceStatus', 'in' => 'query', 'schema' => [ '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 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 accessible during the upgrade.'."\n" ."\n" .'> For more information about instance states, see [Instance states and impacts](~~200740~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Normal', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **PrePaid**: subscription'."\n" .'* **PostPaid**: pay-as-you-go'."\n", 'type' => 'string', 'required' => false, 'example' => 'PostPaid', 'enum' => [ 'PrePaid', 'PostPaid', ], ], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type. Valid values:'."\n" ."\n" .'* **CLASSIC**'."\n" .'* **VPC**'."\n", 'type' => 'string', 'required' => false, 'example' => 'CLASSIC', 'enum' => [ 'CLASSIC', 'VPC', ], ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance. Valid values: **2.8**, **4.0**, **5.0**, **6.0**, and **7.0**.'."\n" ."\n" .'Enumerated values:'."\n" ."\n" .'* 1.0'."\n" .'* 2.8'."\n" .'* 4.0'."\n" .'* 5.0'."\n" .'* 6.0'."\n" .'* 7.0'."\n", 'type' => 'string', 'required' => false, 'example' => '4.0', 'enum' => [ '1.0', '2.8', '4.0', '5.0', '6.0', '7.0', ], ], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type of the instance. For more information, see [Instance types](~~107984~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'redis.master.small.default', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1nme44gek34slfc****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1e7clcw529l773d****', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. Pages start from page **1**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Maximum value: **50**. Default value: **30**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '0', 'example' => '10', 'default' => '30', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'The database engine. Valid values:'."\n" ."\n" .'* **Tair**: Tair (Enterprise Edition)'."\n" .'* **Redis**: Redis Open-Source Edition'."\n" .'* **Memcache**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Redis', 'default' => 'Redis', 'enum' => [ 'Redis', 'Memcache', 'tair_essd', 'tair_scm', 'Tair', 'tair_rdb', 'tair_skv', ], ], ], [ 'name' => 'SearchKey', 'in' => 'query', 'schema' => [ 'description' => 'The keyword used for fuzzy search. The keyword can be based on an instance name or an instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'apitest', ], ], [ 'name' => 'ArchitectureType', 'in' => 'query', 'schema' => [ 'description' => 'The architecture of the instance. Valid values:'."\n" ."\n" .'* **cluster**: cluster architecture'."\n" .'* **standard**: standard architecture'."\n" .'* **rwsplit**: read/write splitting architecture'."\n", 'type' => 'string', 'required' => false, 'example' => 'standard', ], ], [ 'name' => 'Expired', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the instance has expired. Valid values:'."\n" ."\n" .'* **true**: The instance has expired.'."\n" .'* **false**: The instance has not expired.'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong-b', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group to which the instance belongs.'."\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~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', ], ], [ 'name' => 'GlobalInstance', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to return the child instances of distributed instances. Valid values:'."\n" ."\n" .'* **true**: Only child instances are returned.'."\n" .'* **false**: Child instances are not returned.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'EditionType', 'in' => 'query', 'schema' => [ 'description' => 'The edition of the instance. Valid values:'."\n" ."\n" .'* **Community**: Redis Open-Source Edition'."\n" .'* **Enterprise**: Tair (Enterprise Edition)'."\n", 'type' => 'string', 'required' => false, 'example' => 'Enterprise', 'enum' => [ 'Enterprise', 'Community', ], ], ], [ 'name' => 'PrivateIp', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.16.49.***', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The object.'."\n", 'type' => 'object', 'properties' => [ 'Value' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Local disk'."\n", ], 'Key' => [ 'description' => 'The tag key. A tag is a key-value pair.'."\n" ."\n" .'> A maximum of five key-value pairs can be specified at a time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Storage type'."\n", ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'NodeType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => [ 'STAND_ALONE', 'MASTER_SLAVE', 'double', 'single', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1E83311F-0EE4-4922-A3BF-730B312B****', ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'TotalCount' => [ 'description' => 'The total number of instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Instances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'KVStoreInstance' => [ 'description' => 'Details about the instances.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the instance.'."\n", 'type' => 'object', 'properties' => [ 'Connections' => [ 'description' => 'The maximum number of connections supported by the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'EndTime' => [ 'description' => 'The time when the subscription instance expires.'."\n", 'type' => 'string', 'example' => '2019-06-13T16:00:00Z', ], 'ResourceGroupId' => [ 'description' => 'The ID of the resource group to which the instance belongs.'."\n", 'type' => 'string', 'example' => 'rg-acfmyiu4ekp****', ], 'EditionType' => [ 'description' => 'The edition of the instance. Valid values:'."\n" ."\n" .'* **Community**: Redis Open-Source Edition'."\n" .'* **Enterprise**: Tair (Enterprise Edition)', 'type' => 'string', 'example' => 'Enterprise', ], 'Config' => [ 'description' => 'The parameter configurations of the instance. For more information, see [Modify parameters of an instance](~~43885~~).'."\n", '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\\"}', ], 'Port' => [ 'description' => 'The service port of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '6379', ], 'DestroyTime' => [ 'description' => 'The time when the instance was deleted.'."\n", 'type' => 'string', 'example' => '2019-04-28T10:03:01Z', ], 'GlobalInstanceId' => [ 'description' => 'The ID of the distributed instance.'."\n" ."\n" .'> This parameter is returned only if the instance is a child instance of a distributed instance.'."\n", 'type' => 'string', 'example' => 'gr-bp14rkqrhac****', ], 'HasRenewChangeOrder' => [ 'description' => 'Indicates whether your Alibaba Cloud account has pending orders for renewal and configuration change. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'ShardCount' => [ 'description' => 'The number of data shards in the cluster instance.'."\n" ."\n" .'> This parameter is returned only for cloud-native cluster instances or read/write splitting instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'ConnectionDomain' => [ 'description' => 'The internal endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', ], 'SlaveReplicaCount' => [ 'description' => 'The number of replica nodes in the secondary zone.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PrivateIp' => [ 'description' => 'The private IP address.'."\n" ."\n" .'> This parameter is not returned when the instance is deployed in the classic network.'."\n", 'type' => 'string', 'example' => '172.16.49.***', ], 'Capacity' => [ 'description' => 'The storage capacity of the instance. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4096', ], 'QPS' => [ 'description' => 'The number of queries per second (QPS).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100000', ], 'NetworkType' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **CLASSIC**'."\n" .'* **VPC**'."\n", 'type' => 'string', 'example' => 'CLASSIC', ], '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', ], 'PackageType' => [ 'description' => 'The plan type. Valid values:'."\n" ."\n" .'* **standard**: standard plan'."\n" .'* **customized**: custom plan'."\n", 'type' => 'string', 'example' => 'standard', ], 'Bandwidth' => [ 'description' => 'The bandwidth of the instance. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '96', ], 'InstanceType' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* **Tair**'."\n" .'* **Redis**'."\n" .'* **Memcache**'."\n", 'type' => 'string', 'example' => 'Redis', ], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'Details about the tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The object.'."\n", 'type' => 'object', 'properties' => [ 'Value' => [ 'description' => 'The value of the tag.'."\n", 'type' => 'string', 'example' => 'value1', ], 'Key' => [ 'description' => 'The key of the tag.'."\n", 'type' => 'string', 'example' => 'key1', ], ], ], ], ], ], 'ReplacateId' => [ 'description' => 'The logical ID of the distributed instance.'."\n", 'type' => 'string', 'example' => 'grr-bp11381ebc16****', ], 'ArchitectureType' => [ 'description' => 'The architecture of the instance. Default value: NULL. Valid values:'."\n" ."\n" .'* **cluster**: cluster architecture'."\n" .'* **standard**: standard architecture'."\n" .'* **rwsplit**: read/write splitting architecture'."\n" .'* **NULL**: all of the preceding architectures'."\n", 'type' => 'string', 'example' => 'cluster', ], 'EngineVersion' => [ 'description' => 'The database engine version of the instance.'."\n", 'type' => 'string', 'example' => '4.0', ], 'UserName' => [ 'description' => 'The username used to connect to the instance. By default, a username named after the instance ID is included.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b', ], 'CloudType' => [ 'description' => 'This parameter is returned only when the instance is in a cloud box.'."\n", 'type' => 'string', 'example' => 'cloudbox', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'ShardClass' => [ 'description' => 'The shard class. For more information about shard classes, see [Overview](~~26350~~).'."\n" ."\n" .'> The overall performance of a cluster instance is calculated by multiplying the class of a single shard (ShardClass) by the number of shards (ShardCount).'."\n", 'type' => 'string', 'example' => 'redis.shard.small.ce', ], 'CreateTime' => [ 'description' => 'The time when the instance was created.'."\n", 'type' => 'string', 'example' => '2018-11-07T08:49:00Z', ], 'VSwitchId' => [ 'description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-bp1e7clcw529l773d****', ], 'ReplicaCount' => [ 'description' => 'The number of replica nodes in the primary zone.'."\n" ."\n" .'> The **ReplicaCount** and **SlaveReplicaCount** parameters are applicable only to cloud-native instances. If the instance is a cluster instance, the preceding parameters indicate the number of replica nodes **per node** in the primary and secondary zones of the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ReadOnlyCount' => [ 'description' => 'The number of read replicas in the primary zone.'."\n" ."\n" .'> The **ReadOnlyCount** and **SlaveReadOnlyCount** parameters are applicable only to cloud-native instances for which read/write splitting is enabled. If the instance is a cluster instance, the preceding parameters indicate the number of read replicas **per node** in the primary and secondary zones of the instance.'."\n", 'type' => 'string', 'example' => '1', ], 'InstanceClass' => [ 'description' => 'The instance class.'."\n", 'type' => 'string', 'example' => 'redis.logic.sharding.2g.2db.0rodb.4proxy.default', ], 'IsRds' => [ 'description' => 'Indicates whether the instance is managed by ApsaraDB RDS. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'SecondaryZoneId' => [ 'description' => 'The ID of the secondary zone.'."\n" ."\n" .'> If multiple zones are returned for **ZoneId**, such as cn-hangzhou-MAZ10(h,i), this parameter is ignored.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', ], 'InstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'apitest', ], 'SlaveReadOnlyCount' => [ 'description' => 'The number of read replicas in the secondary zone.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'VpcId' => [ 'description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => 'vpc-bp1nme44gek34slfc****', ], 'ChargeType' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **PrePaid**: subscription'."\n" .'* **PostPaid**: pay-as-you-go'."\n", 'type' => 'string', 'example' => 'PostPaid', ], 'ComputingType' => [ 'description' => 'The type of the computing resource. Valid values:'."\n" ."\n" .'* **Ecs**: cloud-native computing service'."\n" .'* **Machine**: physical machine'."\n", 'type' => 'string', 'example' => 'Ecs', ], 'NodeType' => [ 'description' => 'The node type. Valid values:'."\n" ."\n" .'* **double**: The instance contains a master node and a replica node.'."\n" .'* **single**: The instance contains only a master node. This node type is phased out.'."\n", 'type' => 'string', 'example' => 'double', ], 'ConnectionMode' => [ 'description' => 'The connection mode of the instance. Valid values:'."\n" ."\n" .'* **Standard**: standard mode'."\n" .'* **Safe**: database proxy mode'."\n", 'type' => 'string', 'example' => 'Standard', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidInstanceIds.Malformed', 'errorMessage' => 'The Specified parameter InstanceIds is not valid.', ], ], ], 'responseDemo' => '[{"type":"json","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 }\\n ]\\n }\\n}","errorExample":"{\\n \\"PageNumber\\":1,\\n \\"TotalCount\\":38,\\n \\"PageSize\\":10,\\n \\"RequestId\\":\\"9099BAE9-BE8A-4B25-8E96-3C22289C70A6\\",\\n \\"Instances\\":{\\n \\"KVStoreInstance\\":[\\n {\\n \\"Config\\":\\"{\\"EvictionPolicy\\":\\"volatile-lru\\",\\"list-max-ziplist-entries\\":512,\\"zset-max-ziplist-entries\\":128,\\"hash-max-ziplist-entries\\":512,\\"hash-max-ziplist-value\\":64,\\"list-max-ziplist-value\\":64,\\"set-max-intset-entries\\":512,\\"zset-max-ziplist-value\\":64}\\",\\n \\"HasRenewChangeOrder\\":false,\\n \\"InstanceId\\":\\"r-xxxxxxxxxxxxxxx\\",\\n \\"UserName\\":\\"r-xxxxxxxxxxxxxxx\\",\\n \\"ZoneId\\":\\"cn-hangzhou-g\\",\\n \\"ArchitectureType\\":\\"standard\\",\\n \\"NetworkType\\":\\"Classic\\",\\n \\"QPS\\":100000,\\n \\"PackageType\\":\\"standard\\",\\n \\"IsRds\\":true,\\n \\"ConnectionDomain\\":\\"r-xxxxxxxxxxxxxxx.redis.rds.aliyuncs.com\\",\\n \\"EngineVersion\\":\\"2.8\\",\\n \\"InstanceName\\":\\"zhai_test\\",\\n \\"ReplacateId\\":\\"bls-xxxxxxxxxxxxxxx\\",\\n \\"Bandwidth\\":16,\\n \\"ChargeType\\":\\"PostPaid\\",\\n \\"InstanceType\\":\\"Redis\\",\\n \\"InstanceStatus\\":\\"Normal\\",\\n \\"Port\\":6379,\\n \\"InstanceClass\\":\\"redis.master.mid.default\\",\\n \\"RegionId\\":\\"cn-hangzhou\\",\\n \\"CreateTime\\":\\"2018-10-10T04:19:01Z\\",\\n \\"NodeType\\":\\"double\\",\\n \\"Capacity\\":2048,\\n \\"Connections\\":10000\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n 10000\\r\\n rg-acfmyiu4ekp****\\r\\n {"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}\\r\\n 6379\\r\\n false\\r\\n r-bp1wcw2rlw76acc5k****.redis.rds.aliyuncs.com\\r\\n 1024\\r\\n 80000\\r\\n 172.16.49.***\\r\\n Normal\\r\\n VPC\\r\\n 10\\r\\n standard\\r\\n Redis\\r\\n \\r\\n \\r\\n 社区版\\r\\n 类型\\r\\n \\r\\n \\r\\n standard\\r\\n r-bp1wcw2rlw76ac****\\r\\n 5.0\\r\\n cn-hangzhou-f\\r\\n r-bp1wcw2rlw76ac****\\r\\n vsw-bp1w9ouei2nm66qlz****\\r\\n 2020-03-31T06:56:22Z\\r\\n redis.master.small.default\\r\\n true\\r\\n 社区主从50\\r\\n vpc-bp1opxu1zkhn00gzv****\\r\\n PostPaid\\r\\n double\\r\\n cn-hangzhou\\r\\n \\r\\n \\r\\n 1\\r\\n 78DDAA9A-B09E-4BE0-AEAE-10A22924****\\r\\n 30\\r\\n 1\\r\\n","errorExample":"\\n 1\\n 38\\n 10\\n 9099BAE9-BE8A-4B25-8E96-3C22289C70A6\\n \\n \\n {\\"EvictionPolicy\\":\\"volatile-lru\\",\\"list-max-ziplist-entries\\":512,\\"zset-max-ziplist-entries\\":128,\\"hash-max-ziplist-entries\\":512,\\"hash-max-ziplist-value\\":64,\\"list-max-ziplist-value\\":64,\\"set-max-intset-entries\\":512,\\"zset-max-ziplist-value\\":64}\\n false\\n r-xxxxxxxxxxxxxxx\\n r-xxxxxxxxxxxxxxx\\n cn-hangzhou-g\\n standard\\n Classic\\n 100000\\n standard\\n true\\n r-xxxxxxxxxxxxxxx.redis.rds.aliyuncs.com\\n 2.8\\n zhai_test\\n bls-xxxxxxxxxxxxxxx\\n 16\\n PostPaid\\n Redis\\n Normal\\n 6379\\n redis.master.mid.default\\n cn-hangzhou\\n 2018-10-10T04:19:01Z\\n double\\n 2048\\n 10000\\n \\n \\n"}]', 'title' => 'DescribeInstances', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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', ], ], [ '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', ], ], [ '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], [ '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', ], ], ], [ '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****', ], ], [ '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****', ], ], [ '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', ], ], [ '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', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '712CCF2A-16BD-411B-93F7-E978BEF2****', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], '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****', ], 'CharacterType' => [ 'description' => 'The architecture of the instance. Valid values:'."\n" ."\n" .'* **logic**: cluster'."\n" .'* **normal**: standard'."\n", 'type' => 'string', 'example' => 'logic', ], 'VswitchId' => [ 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-t4nvrca24dczppq44****', ], 'InstanceClass' => [ 'description' => 'The instance type.'."\n", 'type' => 'string', 'example' => 'redis.cluster.sharding.common.ce', ], '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', ], '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', ], 'ConnectionDomain' => [ 'description' => 'The private endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com', ], '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', ], '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', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1e7vl6ygf1yq****', ], 'BandWidth' => [ 'description' => 'The default bandwidth of the instance. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '24', ], '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', ], 'EngineVersion' => [ 'description' => 'The database engine version of the instance. The return value is **5.0**.'."\n", 'type' => 'string', 'example' => '5.0', ], 'RegionId' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'testdb', ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-e', ], 'ClusterName' => [ 'description' => 'The name of the dedicated cluster to which the instance belongs.'."\n", 'type' => 'string', 'example' => 'testname', ], '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', ], 'Engine' => [ 'description' => 'The database engine. The return value is **redis**.'."\n", 'type' => 'string', 'example' => 'redis', ], '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', ], 'CustomId' => [ 'description' => 'An internal parameter used for the maintenance and management of instances.'."\n", 'type' => 'string', 'example' => '4652****', ], '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', ], 'ClusterId' => [ 'description' => 'The ID of the dedicated cluster to which the instance belongs.'."\n", 'type' => 'string', 'example' => 'dhg-rx71fc5ndh9o****', ], '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.***', ], 'DedicatedHostName' => [ 'description' => 'The ID of the host in the dedicated cluster.'."\n", 'type' => 'string', 'example' => 'ch-bp13vf0y9gx3c****', ], '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', ], 'ZoneId' => [ 'description' => 'The zone ID of the node.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-h', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1e7vl6ygf1yq****', ], 'Port' => [ 'description' => 'The port number that is used to connect to the node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3001', ], 'Role' => [ 'description' => 'The role of the node. Valid values:'."\n" ."\n" .'* **master**: master node'."\n" .'* **slave**: replica node'."\n", 'type' => 'string', 'example' => 'master', ], 'NodeId' => [ 'description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '17921111', ], ], ], ], ], ], ], ], 'description' => '', ], ], ], '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' => ' ', ], 'DescribeInstanceAttribute' => [ 'summary' => 'Queries the attribute of 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' => '56403', 'abilityTreeNodes' => [ 'FEATUREkvstoreSIWMD9', ], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CA40C261-EB72-4EDA-AC57-958722162595', ], 'Instances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBInstanceAttribute' => [ 'description' => 'Details about the instances.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => 'The ID of the virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => 'vpc-bp1nme44gek34slfc****', ], 'PrivateIp' => [ 'description' => 'The private IP address of the instance.'."\n" ."\n" .'> This parameter is not returned when the instance is deployed in the classic network.'."\n", 'type' => 'string', 'example' => '172.16.49.***', ], 'Capacity' => [ 'description' => 'The storage capacity of the instance. Unit: MB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], '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.'."\n", 'type' => 'string', 'example' => '2019-03-06T10:42:03Z', ], 'ConnectionDomain' => [ 'description' => 'The internal endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com', ], 'IsRds' => [ 'description' => 'Indicates whether the instance is managed by ApsaraDB RDS. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ChargeType' => [ 'description' => 'The billing method of the instance. Valid values:'."\n" ."\n" .'* **PrePaid**: subscription'."\n" .'* **PostPaid**: pay-as-you-go'."\n", 'type' => 'string', 'example' => 'PostPaid', ], 'StorageType' => [ 'description' => 'The storage type.'."\n", 'type' => 'string', 'example' => 'essd_pl1', ], 'VpcAuthMode' => [ 'description' => 'Indicates whether password authentication is enabled. Valid values:'."\n" ."\n" .'* **Open**: Password authentication is enabled.'."\n" .'* **Close**: Password authentication is disabled and [password-free access](~~85168~~) is enabled.'."\n", 'type' => 'string', 'example' => 'Open', ], 'ArchitectureType' => [ 'description' => 'The architecture of the instance. Valid values:'."\n" ."\n" .'* **cluster**: cluster architecture'."\n" .'* **standard**: standard architecture'."\n" .'* **rwsplit**: read/write splitting architecture'."\n", 'type' => 'string', 'example' => 'standard', ], 'AvailabilityValue' => [ 'description' => 'The availability metric of the current month.'."\n", 'type' => 'string', 'example' => '100%', ], 'NetworkType' => [ 'description' => 'The network type of the instance. Valid values:'."\n" ."\n" .'* **CLASSIC**'."\n" .'* **VPC**'."\n", 'type' => 'string', 'example' => 'CLASSIC', ], 'Port' => [ 'description' => 'The service port of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '6379', ], 'SecondaryZoneId' => [ 'description' => 'The ID of the secondary zone.'."\n" ."\n" .'> This parameter is returned only if the instance has a secondary zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hongkong-h', ], 'PackageType' => [ 'description' => 'The plan type. Valid values:'."\n" ."\n" .'* **standard**: standard plan.'."\n" .'* **customized**: custom plan. This plan type is phased out.'."\n", 'type' => 'string', 'example' => 'standard', ], 'EngineVersion' => [ 'description' => 'The database engine version of the instance. Valid values: **2.8**, **4.0**, **5.0**, **6.0**, and **7.0**.'."\n", 'type' => 'string', 'example' => '4.0', ], 'Config' => [ 'description' => 'The parameter configurations of the instance in the JSON format. For more information, see [Parameter descriptions](~~43885~~). You can use the [DescribeAuditLogConfig](~~473830~~) operation to query audit log configurations.'."\n", '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}', ], 'VpcCloudInstanceId' => [ 'description' => 'The ID of the instance in the VPC.'."\n", 'type' => 'string', 'example' => 'r-bp1d72gwl41z7f****', ], 'Bandwidth' => [ 'description' => 'The bandwidth of the instance. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'InstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'apitest', ], 'SecurityIPList' => [ 'description' => 'The IP addresses in the whitelist.'."\n", 'type' => 'string', 'example' => '127.0.0.1', ], 'ShardCount' => [ 'description' => 'The number of shards. This parameter is available only for instances that are purchased on the China site (aliyun.com).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ReplicaCount' => [ 'description' => 'The number of replica nodes in the primary zone.'."\n" ."\n" .'> The **ReplicaCount** and **SlaveReplicaCount** parameters are applicable only to cloud-native instances. If the instance is a cluster instance, the preceding parameters indicate the number of replica nodes **per node** in the primary and secondary zones of the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SlaveReplicaCount' => [ 'description' => 'The number of replica nodes in the secondary zone.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ReadOnlyCount' => [ 'description' => 'The number of read replicas. This parameter is available only for read/write splitting instances that use cloud disks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'SlaveReadOnlyCount' => [ 'description' => 'The number of read replicas in the secondary zone. This parameter is returned only after read/write splitting is enabled for the instance across multiple zones.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'GlobalInstanceId' => [ 'description' => 'The ID of the distributed instance to which the instance belongs.'."\n" ."\n" .'> This parameter is returned only when the Tair (Redis OSS-compatible) instance is a child instance of a distributed instance.', 'type' => 'string', 'example' => 'gr-bp14rkqrhac****', ], 'QPS' => [ 'description' => 'The expected maximum queries per second (QPS).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100000', ], 'AuditLogRetention' => [ 'description' => 'The retention period of audit logs. Unit: day. A value of 0 indicates that the audit log feature is disabled. For information about how to enable the feature, see [Enable the audit log feature](~~102015~~).'."\n", 'type' => 'string', 'example' => '15', ], 'ZoneType' => [ 'description' => 'The deployment type of the instance. Valid values:'."\n" ."\n" .'* **singlezone**: The instance is deployed in a single zone.'."\n" .'* **doublezone**: The instance is deployed in two zones of the same region.'."\n", 'type' => 'string', 'example' => 'singlezone', ], 'MaintainStartTime' => [ 'description' => 'The start time of the maintenance window. The time is in the *HH:mmZ* format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '18:00Z', ], 'MaintainEndTime' => [ 'description' => 'The end time of the maintenance window. The time is in the *HH:mmZ* format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '22:00Z', ], 'InstanceClass' => [ 'description' => 'The instance type. For more information, see [Instance types](~~107984~~).'."\n", 'type' => 'string', 'example' => 'redis.master.small.default', ], 'RealInstanceClass' => [ 'description' => 'If the instance is a cluster instance that uses cloud disks, this parameter indicates the actual instance type of individual shards in the instance. The InstanceClass parameter indicates the virtual instance type.'."\n" ."\n" .'> To query fees for instances of the instance type, you can specify the instance type that is returned by this parameter in the [DescribePrice](~~473807~~) operation.', 'type' => 'string', 'example' => 'tair.rdb.with.proxy.1g', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1d72gwl41z7f****', ], 'InstanceType' => [ 'description' => 'The database engine of the instance. Valid values:'."\n" ."\n" .'* **Tair**'."\n" .'* **Redis**'."\n" .'* **Memcache**'."\n", 'type' => 'string', 'example' => 'Redis', ], 'HasRenewChangeOrder' => [ 'description' => 'Indicates whether your Alibaba Cloud account has pending orders for renewal and configuration change. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'string', 'example' => 'false', ], 'InstanceReleaseProtection' => [ 'description' => 'Indicates whether the release protection feature is enabled for the instance. Valid values:'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'false', ], 'ReplicationMode' => [ 'description' => 'The architecture of the replica node. Valid values:'."\n" ."\n" .'* **master-slave**: the standard master-replica architecture.'."\n" .'* **cluster**: the cluster architecture, which includes the read/write splitting instances and cluster instances.'."\n", 'type' => 'string', 'example' => 'master-slave', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'EndTime' => [ 'description' => 'The time when the subscription expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2019-04-06T10:42:03Z', ], 'VSwitchId' => [ 'description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-bp1e7clcw529l773d****', ], 'ReplicaId' => [ 'description' => 'The ID of the replica node.'."\n", 'type' => 'string', 'example' => 'bls-awxxxxxxxxxxxxx', ], 'NodeType' => [ 'description' => 'The node type. Valid values:'."\n" ."\n" .'* **double**: The instance contains a master node and a replica node.'."\n" .'* **single**: The instance is a standalone instance.'."\n", 'type' => 'string', 'example' => 'double', ], 'Connections' => [ 'description' => 'The maximum number of connections supported by the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000', ], 'BackupLogStartTime' => [ 'description' => 'The earliest point in time to which data can be restored. 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" .'> '."\n" ."\n" .'* This parameter is returned only when the data flashback feature is enabled for the instance. For more information, see [Restore data to a point in time by using the data flashback feature](~~148479~~).'."\n" ."\n" .'* When you call the [RestoreInstance](~~473824~~) operation to implement data flashback, you can obtain the earliest point in time for data flashback from the return value of this parameter and set the **RestoreTime** parameter to this point in time.', 'type' => 'string', 'example' => '2021-07-06T05:49:55Z', ], 'ResourceGroupId' => [ 'description' => 'The ID of the resource group to which the instance belongs.'."\n", 'type' => 'string', 'example' => 'rg-acfmyiu4ekp****', ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hongkong-b', ], '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" ."\n" .'> For more information about instance states, see [Instance states and impacts](~~200740~~).'."\n", 'type' => 'string', 'example' => 'Normal', ], 'Engine' => [ 'description' => 'The database engine of the instance. The return value is **Redis**.'."\n", 'type' => 'string', 'example' => 'Redis', ], 'Storage' => [ 'description' => 'The storage capacity of the cloud disk.'."\n", 'type' => 'string', 'example' => '50', ], 'CloudType' => [ 'description' => 'This parameter is returned only when the instance is in a cloud box.'."\n", 'type' => 'string', 'example' => 'cloudbox', ], 'IsOrderCompleted' => [ 'description' => 'Indicates whether the order for instance configuration change has reached the final state. Valid values:'."\n" ."\n" .'* **true**: The configuration change has been completed or has not been performed.'."\n" .'* **false**: The configurations of the instance are being changed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'IsSupportTDE' => [ 'description' => 'Indicates whether the transparent data encryption (TDE) feature is supported for the instance. Valid values:'."\n" ."\n" .'* **true**: This feature is supported only for DRAM-based classic instances.'."\n" .'* **false**: This feature is not supported.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'Details about the tags.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'tagkey', ], 'Value' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'tagvalue', ], ], ], ], ], ], 'AutoSecondaryZone' => [ 'description' => 'Indicates whether a secondary zone is automatically allocated.'."\n" ."\n" .'* **true**'."\n" .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ComputingType' => [ 'type' => 'string', ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n \\n \\n 10000\\n rg-acfmyiu4ekp****\\n {\\"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 6379\\n false\\n singlezone\\n r-bp1wcw2rlw76acc5k****.redis.rds.aliyuncs.com\\n 22:00Z\\n 1024\\n 100000\\n 172.16.49.***\\n 127.0.0.1\\n Normal\\n VPC\\n 10\\n standard\\n false\\n Redis\\n 100.0%\\n Redis\\n 18:00Z\\n \\n \\n 社区版\\n 类型\\n \\n \\n standard\\n 5.0\\n cn-hangzhou-f\\n r-bp1wcw2rlw76ac****\\n vsw-bp1w9ouei2nm66qlz****\\n 2020-03-31T14:56:22Z\\n redis.master.small.default\\n 7\\n true\\n master-slave\\n 社区主从50\\n vpc-bp1opxu1zkhn00gzv****\\n PostPaid\\n Open\\n double\\n r-bp1wcw2rlw76ac****\\n cn-hangzhou\\n \\n \\n D67A69DF-C1FC-4B01-B239-B17888CCFD2A\\n","errorExample":""}]', 'title' => 'DescribeInstanceAttribute', ], '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****', ], ], [ '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', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries to return each page.'."\n", 'type' => 'string', 'required' => false, 'example' => '20', 'default' => '20', ], ], [ '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F3F44BE3-5419-4B61-9BAC-E66E295A****', ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], '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', ], 'GlobalInstanceId' => [ 'description' => 'The ID of the distributed instance.'."\n", 'type' => 'string', 'example' => 'gr-bp14rkqrhac****', ], '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', ], 'InstanceID' => [ 'description' => 'The ID of the child instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], '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', ], 'GlobalInstanceId' => [ 'description' => 'The ID of the distributed instance.'."\n", 'type' => 'string', 'example' => 'gr-bp14rkqrhac****', ], 'RegionId' => [ 'description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], ], ], ], ], ], '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', '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", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], ], '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', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A52974D1-9D57-4805-86CC-92E6EDE8****', ], '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', ], '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\\":\\"Feature optimization: The stability is improved.\\"}],\\"versionChangesLevel\\":2}', ], '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\\":\\"New feature: Some internal commands are supported.\\"}],\\"versionChangesLevel\\":2}', ], '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', ], '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', ], 'MajorVersion' => [ 'description' => 'The major version of the instance.'."\n", 'type' => 'string', 'example' => '5.0', ], 'Engine' => [ 'description' => 'The database engine. Valid values: **redis** and **memcache**.'."\n", 'type' => 'string', 'example' => 'redis', ], 'MinorVersion' => [ 'description' => 'The current minor version of the instance.'."\n", 'type' => 'string', 'example' => 'redis-5.0_0.5.0', ], 'IsRedisCompatibleVersion' => [ 'description' => 'Indicates whether the instance runs a Redis version.'."\n", 'type' => 'string', 'example' => '1', ], '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', ], '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', ], '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', ], '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', ], 'Level' => [ 'description' => 'The version update level. Valid values:'."\n" ."\n" .'* **0**: regular'."\n" .'* **1**: recommended'."\n" .'* **2**: critical'."\n", 'type' => 'string', 'example' => '0', ], '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', ], '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', ], 'CreateTime' => [ 'description' => 'The creation time of the instance.'."\n", 'type' => 'string', 'example' => '2022-11-21T13:28Z'."\n", ], 'ReleaseNote' => [ 'description' => 'The release notes.'."\n", 'type' => 'string', 'example' => 'netbank1022', ], 'Level' => [ 'description' => 'The importance level.'."\n", 'type' => 'string', 'example' => '0', ], 'ReleaseNoteEn' => [ 'description' => 'The description of the minor versions to which the instance can be updated.'."\n", 'type' => 'string', 'example' => 'ReleaseNoteEn', ], ], ], ], ], ], ], ], ], ], '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'."\n", ], 'Level' => [ 'description' => 'The version update level. Valid values:'."\n" ."\n" .'* **0**: regular'."\n" .'* **1**: recommended'."\n" .'* **2**: critical'."\n", 'type' => 'string', 'example' => '0', ], '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'."\n", ], 'CreateTime' => [ 'description' => 'The time when the version was released.'."\n", 'type' => 'string', 'example' => '2022-08-23T14:26:20Z', ], 'ReleaseNote' => [ 'description' => 'The release notes.'."\n", 'type' => 'string', 'example' => 'x x x x', ], 'Level' => [ 'description' => 'The version update level. Valid values:'."\n" ."\n" .'* **0**: regular'."\n" .'* **1**: recommended'."\n" .'* **2**: critical'."\n", 'type' => 'string', 'example' => '0', ], 'ReleaseNoteEn' => [ 'description' => 'The description of the minor versions to which the instance can be updated.'."\n", 'type' => 'string', 'example' => 'ReleaseNoteEn', ], ], ], ], ], ], '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', ], ], ], ], ], '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', ], ], 'description' => '', ], ], ], '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":"\\n 5.0\\n false\\n 825F9CF7-4AE5-520C-93C7-7E0D2BEA0F8F\\n redis-5.0_0.5.0\\n 6.6.0\\n redis\\n true\\n {\\"releaseInfo\\":[{\\"createTime\\":\\"2021-05-26\\",\\"level\\":0,\\"releaseVersion\\":\\"6.6.1\\",\\"releaseNote\\":\\"[新特性]:新增TairZset数据结构，实现任意维度的double类型的分值排序，提升数据处理效率，且客户端适配简易，无需任何编解码封装。更多信息，请参见TairZset命令。\\"},{\\"createTime\\":\\"2021-06-08\\",\\"level\\":0,\\"releaseVersion\\":\\"6.6.2\\",\\"releaseNote\\":\\"[新特性]:增加对部分内部命令的支持。\\"},{\\"createTime\\":\\"2021-06-18\\",\\"level\\":1,\\"releaseVersion\\":\\"6.6.3\\",\\"releaseNote\\":\\"[功能优化]:优化多可用区容灾场景下的内部管控。\\"},{\\"createTime\\":\\"2021-07-08\\",\\"level\\":2,\\"releaseVersion\\":\\"6.6.4\\",\\"releaseNote\\":\\"[新特性]:CLIENT LIST、CLIENT KILL命令支持展示和操作进程维度的连接。\\\\n[缺陷修复]:修复TairZset命令不支持大写的问题，更多信息，请参见TairZset命令。\\"}],\\"versionChangesLevel\\":2}\\n false\\n {\\"releaseInfo\\":[{\\"createTime\\":\\"2021-04-26\\",\\"level\\":2,\\"releaseVersion\\":\\"0.5.2\\",\\"releaseNote\\":\\"[安全加固]:主要解决社区Lua JIT的安全性漏洞。\\\\n[新特性]:优化槽（slot）的迁移能力，云盘版实例可基于此实现无损扩缩容。\\\\n[新特性]:支持大Key（big key）实时统计。\\\\n[新特性]:支持通过公网获取虚拟IP（VIP）地址，为使用直连地址用户提供更好的支持。\\\\n\\"},{\\"createTime\\":\\"2021-07-21\\",\\"level\\":1,\\"releaseVersion\\":\\"0.5.3\\",\\"releaseNote\\":\\"[功能更新]:优化数据迁移完成后删除源端数据的流程，增强数据可靠性。\\\\n[功能更新]:简化数据迁移的增量数据同步流程。\\"},{\\"createTime\\":\\"2021-07-27\\",\\"level\\":1,\\"releaseVersion\\":\\"0.5.4\\",\\"releaseNote\\":\\"[功能更新]:增强稳定性。\\"}],\\"versionChangesLevel\\":2}\\n","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', '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", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ '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' => '', ], ], [ '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', ], ], [ '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', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '224B97FB-A275-4EAC-86E9-8922FEA2****', ], 'PageNumber' => [ 'description' => 'The number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], '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', ], 'CurrentMinorVersion' => [ 'description' => 'The minor version of the node.'."\n", 'type' => 'string', 'example' => 'redis-5.0_0.3.10', ], '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', ], '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', ], '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', ], 'InsName' => [ 'description' => 'The ID of the node.'."\n", 'type' => 'string', 'example' => 'r-t4nlenc2p04uvb****', ], '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', ], 'ZoneId' => [ 'description' => 'The ID of the zone.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-b', ], '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', ], 'CustinsId' => [ 'description' => 'The ID of the data shard.'."\n", 'type' => 'string', 'example' => '30381****', ], 'Role' => [ 'description' => 'The role of the node. Valid values:'."\n" ."\n" .'* **master**: master node'."\n" .'* **slave**: replica node'."\n", 'type' => 'string', 'example' => 'master', ], 'NodeId' => [ 'description' => 'This parameter is used only for internal maintenance of instances.'."\n", 'type' => 'string', 'example' => '10065****', ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2D9F3768-EDA9-4811-943E-42C8006E****', ], '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', ], 'UserId' => [ 'description' => 'The ID of the user.'."\n", 'type' => 'string', 'example' => '2****_176498472570****', ], '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', ], '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', ], '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', ], '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', ], 'BizType' => [ 'description' => 'The type of workload. The return value is **ALIYUN**.'."\n", 'type' => 'string', 'example' => 'ALIYUN', ], 'Service' => [ 'description' => 'The node type. Valid values:'."\n" ."\n" .'* **redis**: data node'."\n" .'* **redis_cs**: config server'."\n", 'type' => 'string', 'example' => 'redis', ], 'BinlogRetentionDays' => [ 'description' => 'The retention period of binlogs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'Connections' => [ 'description' => 'The maximum number of connections supported by the data node.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20000', ], 'ResourceGroupName' => [ 'description' => 'The name of the resource group to which the node belongs.'."\n", 'type' => 'string', 'example' => 'GLOBAL_ZHANGJIAKOU_A', ], 'ServiceVersion' => [ 'description' => 'The major version of the node.'."\n", 'type' => 'string', 'example' => '5.0', ], 'ReplicaSize' => [ 'description' => 'The number of replica nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Name' => [ 'description' => 'The name of the data node.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****-db-0', ], 'Id' => [ 'description' => 'The ID of the replica set in the node.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '501791111', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], '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' => ' ', ], 'DescribeDBInstanceNetInfo' => [ 'summary' => 'Queries the network information of a Tair (Redis OSS-compatible) 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 ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'NetType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'enum' => [ 'Private', 'Public', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceNetworkType' => [ 'description' => 'The network type. Valid values:'."\n" ."\n" .'* **CLASSIC**: The instance runs in a classic network.'."\n" .'* **VPC**: The instance runs in a virtual private cloud (VPC).'."\n", 'type' => 'string', 'example' => 'CLASSIC', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B', ], 'NetInfoItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'InstanceNetInfo' => [ 'description' => 'The network information about the instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DirectConnection' => [ 'description' => 'Indicates whether the address is a private endpoint. Valid values:'."\n" ."\n" .'* **0**: The address is not a private endpoint.'."\n" .'* **1**: The address is a private endpoint.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'VSwitchId' => [ 'description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-bp1e7clcw529l773d****', ], 'DBInstanceNetType' => [ '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', 'example' => '1', ], 'Upgradeable' => [ 'description' => 'The remaining validity period of the classic network endpoint. Unit: seconds.'."\n" ."\n" .'> **A value of 0 indicates that the endpoint never expires.'."\n", 'type' => 'string', 'example' => '0', ], 'ExpiredTime' => [ 'description' => 'The expiration time of the classic network endpoint. Unit: seconds.'."\n", 'type' => 'string', 'example' => '5183779', ], 'ConnectionString' => [ 'description' => 'The endpoint of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', ], 'IPType' => [ 'description' => 'The network type of the IP address. Valid values:'."\n" ."\n" .'* **Public**: Internet'."\n" .'* **Inner**: classic network'."\n" .'* **Private**: VPC'."\n", 'type' => 'string', 'example' => 'Inner', ], 'VPCInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1ky7j6qc7umk****', ], 'Port' => [ 'description' => 'The service port of the instance.'."\n", 'type' => 'string', 'example' => '6379', ], 'VPCId' => [ 'description' => 'The ID of the VPC to which the instance belongs.'."\n", 'type' => 'string', 'example' => 'vpc-bp1nme44gek34slfc****', ], 'IPAddress' => [ 'description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '172.16.49.***', ], 'IsSlaveProxy' => [ 'description' => 'Indicates whether the address is the endpoint for the secondary zone. Valid values: 1 and 0. A value of 1 indicates that the address is the endpoint for the secondary zone.'."\n" ."\n" .'> This parameter is returned only after you enable the multi-zone read/write splitting architecture for the instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","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}","errorExample":"{\\n \\"RequestId\\":\\"314C4FB3-4256-424F-9AD9-1A6B3444160A\\",\\n \\"InstanceNetworkType\\":\\"Classic\\",\\n \\"NetInfoItems\\":{\\n \\"InstanceNetInfo\\":[{\\n \\"DBInstanceNetType\\":\\"1\\",\\n \\"Port\\":\\"6379\\",\\n \\"ConnectionString\\":\\"r-xxxxxxxxxxxxxxx.redis.rds.aliyuncs.com\\",\\n \\"VPCId\\":\\"\\",\\n \\"IPAddress\\":\\"xxx.xxx.xxx.xxx\\",\\n \\"IPType\\":\\"Inner\\",\\n \\"Upgradeable\\":\\"0\\"\\n \\t\\t\\t\\t }]\\n \\t\\t\\t }\\n}"},{"type":"xml","example":"\\n\\n \\n Private\\n r-bp1ky7j6qc7umk****\\n vpc-bp1opxu1zkhn00gzv****\\n 2\\n 6379\\n 0\\n 0\\n r-bp1ky7j6qc7umk****.redis.rds.aliyuncs.com\\n 172.16.49.***\\n \\n\\n500F0FD3-5065-4A1D-A27C-BBC567956068\\nVPC\\n","errorExample":"\\n 314C4FB3-4256-424F-9AD9-1A6B3444160A\\n Classic\\n \\n \\n 1\\n 6379\\n r-xxxxxxxxxxxxxxx.redis.rds.aliyuncs.com\\n \\n xxx.xxx.xxx.xxx\\n Inner\\n 0\\n \\n \\n"}]', 'title' => 'DescribeDBInstanceNetInfo', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ABAF95F6-35C1-4177-AF3A-70969EBD****', ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], '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', ], 'Vip' => [ 'description' => 'The VIP of the shard.'."\n", 'type' => 'string', 'example' => '100.115.61.8', ], 'Port' => [ 'description' => 'The port number. Valid values: **1024** to **65535**. Default value: **6379**.'."\n", 'type' => 'string', 'example' => '6379', ], 'NetType' => [ 'description' => 'The network type of the security group. Valid values:'."\n" ."\n" .'* **vpc**: Virtual Private Cloud (VPC)'."\n", 'type' => 'string', 'example' => 'vpc', ], ], ], ], ], ], ], 'description' => '', ], ], ], '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", ], 'DescribeLogicInstanceTopology' => [ 'summary' => 'Queries the logical topology of a Tair (Redis OSS-compatible) 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 ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '794120D1-E0CF-4713-BAE4-EBAEA04506AF', ], 'RedisProxyList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'NodeInfo' => [ 'description' => 'The detailed proxy information, including information about proxy nodes.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Capacity' => [ 'description' => 'The storage capacity of the node. Unit: MB.'."\n", 'type' => 'string', 'example' => '5120', ], 'Connection' => [ 'description' => 'The maximum number of connections.'."\n", 'type' => 'string', 'example' => '320000', ], 'NodeType' => [ 'description' => 'The node type. Valid values:'."\n" ."\n" .'* **proxy**: proxy node'."\n" .'* **db**: data node'."\n", 'type' => 'string', 'example' => 'proxy', ], 'Bandwidth' => [ 'description' => 'The bandwidth throttling of the node. Unit: MB/s.'."\n", 'type' => 'string', 'example' => '96', ], 'NodeId' => [ 'description' => 'The ID of the node.'."\n", 'type' => 'string', 'example' => 'r-bp10noxlhcoim2****-proxy-3#542****', ], ], 'description' => '', ], ], ], ], 'RedisShardList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'NodeInfo' => [ 'description' => 'Details of data shards, which includes node information such as NodeInfo.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Capacity' => [ 'description' => 'The storage capacity of the node. Unit: MB.'."\n", 'type' => 'string', 'example' => '2048', ], 'Connection' => [ 'description' => 'The maximum number of connections.'."\n", 'type' => 'string', 'example' => '10000', ], 'NodeType' => [ 'description' => 'The node type. Valid values:'."\n" ."\n" .'* **proxy**: proxy node'."\n" .'* **db**: data node'."\n", 'type' => 'string', 'example' => 'db', ], 'Bandwidth' => [ 'description' => 'The bandwidth throttling of the node. Unit: MB/s.'."\n", 'type' => 'string', 'example' => '96', ], 'NodeId' => [ 'description' => 'The ID of the node.'."\n", 'type' => 'string', 'example' => 'r-bp10noxlhcoim2****-db-0#688****', ], 'SubInstanceType' => [ 'description' => '子实例类型，返回值：'."\n" .'* **master**：主节点类型。'."\n" .'* **readonly**：只读实例类型。', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'master', ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","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}","errorExample":"{\\n \\"RedisShardList\\":\\n {\\"NodeInfo\\":[{\\n \\"NodeId\\":\\"r-xxxxxxxxxxxxxxx-proxy-3#5425423\\",\\n \\"NodeType\\":\\"proxy\\",\\n \\"Capacity\\":\\"5120\\",\\n \\"Connection\\":\\"320000\\",\\n \\"Bandwidth\\":96\\n\\t\\t\\t\\t }]},\\n \\"InstanceId\\":\\"r-xxxxxxxxxxxxxxx\\",\\n \\"RequestId\\":\\"5F749626-2B6A-4DC2-A010-B51F7C33084E\\"\\n }"},{"type":"xml","example":"\\n \\n \\n 2048\\n 96\\n db\\n r-bp10noxlhcoim2****-db-0#14965569\\n 30000\\n \\n \\n 2048\\n 96\\n db\\n r-bp10noxlhcoim2****-db-1#14965575\\n 30000\\n \\n \\n B5250FA2-CB49-4B68-9263-721099AC928A\\n r-bp10noxlhcoim2****\\n \\n \\n 5120\\n 96\\n proxy\\n r-bp10noxlhcoim2****-proxy-0#14965583\\n 20000\\n \\n \\n 5120\\n 96\\n proxy\\n r-bp10noxlhcoim2****-proxy-1#14965585\\n 20000\\n \\n \\n 5120\\n 96\\n proxy\\n r-bp10noxlhcoim2****-proxy-2#14965587\\n 20000\\n \\n \\n 5120\\n 96\\n proxy\\n r-bp10noxlhcoim2****-proxy-3#14965589\\n 20000\\n \\n \\n 5120\\n 96\\n proxy\\n r-bp10noxlhcoim2****-proxy-4#14965591\\n 20000\\n \\n \\n 5120\\n 96\\n proxy\\n r-bp10noxlhcoim2****-proxy-5#14965571\\n 20000\\n \\n \\n","errorExample":"\\n \\n \\n r-xxxxxxxxxxxxxxx-proxy-3#5425423\\n proxy\\n 5120\\n 320000\\n 96\\n \\n \\n r-xxxxxxxxxxxxxxx\\n 5F749626-2B6A-4DC2-A010-B51F7C33084E\\n"}]', 'title' => 'DescribeLogicInstanceTopology', 'description' => 'This parameter is supported only for cluster and read/write splitting instances.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ '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', ], ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EFC9161F-15E3-4A6E-8A99-C33331****', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '11111****', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support this operation.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '82E30AB7-E3A4-46AC-88A0-3E4DCDC5****', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '21986****', ], ], ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], '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", ], '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****', ], ], ], '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', ], ], ], ], ], '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', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SwitchInstanceHA' => [ 'summary' => 'Performs a master-replica switchover to switch node roles. This operation is applicable to disaster recovery drills and nearby access to applications that are deployed across zones.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56519', 'abilityTreeNodes' => [ 'FEATUREkvstoreSIWMD9', ], ], '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****', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the data shard. You can call the [DescribeRoleZoneInfo](~~473782~~) operation to obtain the value of the CustinsId parameter. Separate multiple data shard IDs with commas (,). `all` indicates that all data shards are specified.'."\n" ."\n" .'> This parameter is available and required only for read/write splitting and cluster instances.', 'type' => 'string', 'required' => false, 'example' => '56****19,56****20', ], ], [ 'name' => 'SwitchMode', 'in' => 'query', 'schema' => [ 'description' => 'The time when to perform the switchover. Default value: 0. Valid values:'."\n" ."\n" .'* **0**: immediately performs the switchover.'."\n" .'* **1**: performs the switchover during the maintenance window.'."\n" ."\n" .'> You can call the [ModifyInstanceMaintainTime](~~473775~~) operation to modify the maintenance window of a Tair (Redis OSS-compatible) instance.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'SwitchType', 'in' => 'query', 'schema' => [ 'description' => 'The switching mode. Valid values:'."\n" ."\n" .'* **AvailablePriority**: immediately performs a switchover by prioritizing availability. No latency of data synchronization between the master and replica nodes is considered. This may cause data loss.'."\n" .'* **ReliabilityPriority**: performs a switchover by prioritizing reliability. Make sure that no latency of data synchronization between the master and replica nodes exists. This ensures data integrity. This mode may cause switchover failures in scenarios where a large volume of data is written and data synchronization latency consistently exists.'."\n" ."\n" .'> You must evaluate the requirements for data and services based on your business scenarios and then select a switching mode.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'enumValueTitles' => [ 'AvailablePriority' => 'AvailablePriority', 'ReliabilityPriority' => 'ReliabilityPriority', ], 'example' => 'AvailablePriority', 'default' => 'ReliabilityPriority', 'enum' => [ 'AvailablePriority', 'ReliabilityPriority', 'DataConsistency', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D622714-AEDD-4609-9167-F5DDD3D1****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 5D622714-AEDD-4609-9167-F5DDD3D1****\\n","errorExample":""}]', 'title' => 'SwitchInstanceHA', 'description' => '> For more information about nearby access to applications that are deployed across zones, see [Switch node roles](~~164222~~).'."\n" ."\n" .'The instance must be a Redis Open-Source Edition instance or Tair (Enterprise Edition) [DRAM-based](~~126164~~) instance that uses local disks.'."\n" ."\n" .'A call to this operation has the following impacts on your instance:'."\n" ."\n" .'* The data shards in the instance may change to the read-only state and experience transient connections within seconds. Make sure that your application is configured to automatically reconnect to the instance.'."\n" .'* If the instance enters the switching state, you cannot manage this instance. For example, you cannot modify the instance configurations or migrate the instance to another zone.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ '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', ], ], ], [ '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], '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', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], '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' => ' ', ], '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****', ], ], [ 'name' => 'LockReason', 'in' => 'query', 'schema' => [ 'description' => 'The reason why write operations on the instance are locked.'."\n", 'type' => 'string', 'required' => true, 'example' => 'lock reason', ], ], ], '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' => '2BE6E619-A657-42E3-AD2D-18F8428A****', ], 'DBInstanceName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-2ev03avw0r0552***', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '21986****', ], 'LockReason' => [ 'description' => 'The reason why write operations on the instance are locked.'."\n", 'type' => 'string', 'example' => 'lock reason', ], ], ], ], ], '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', ], '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****', ], ], ], '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' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], 'DBInstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'r-2ev03avw0r0552***', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10****', ], ], ], ], ], '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', ], '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****', ], ], [ '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', ], ], [ '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', ], ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****', ], ], 'description' => '', ], ], ], '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", ], '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****', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B830CDBB-91D9-5571-B6F4-35C76266****', ], ], 'description' => '', ], ], ], '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", ], '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****', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9C4AF387-1EA3-4C84-8013-3F6B973EDDF5', ], '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', ], 'DBInstanceNetType' => [ 'description' => 'The network type of the instance. The returned value is **Classic**.'."\n", 'type' => 'string', 'example' => 'Classic', ], 'ConnectionString' => [ 'description' => 'The endpoint of the classic network.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', ], 'ExpiredTime' => [ 'description' => 'The expiration time of the classic network endpoint.'."\n", 'type' => 'string', 'example' => '2019-08-01T09:29:18Z', ], 'IPAddress' => [ 'description' => 'The IP address of the instance in the classic network.'."\n", 'type' => 'string', 'example' => '100.118.142.***', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ClassicExpiredDaysError', 'errorMessage' => 'The ClassicExpiredDays can not set to 0.', ], ], ], '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' => ' ', ], 'ModifyDBInstanceConnectionString' => [ 'summary' => 'Changes the endpoint or port number of 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' => '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****', ], ], [ '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' => 'standardredis', ], ], [ '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', ], ], [ '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+$', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1790D68A-465C-44E3-BC24-9732652961F9', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NewConnectionStringNotSupport', 'errorMessage' => 'Specified newConnectionString is not supported.', ], [ 'errorCode' => 'InvalidIPType.Format', 'errorMessage' => 'Specified parameter IPType is not supported.', ], [ 'errorCode' => 'InvalidConnectionStringOrPort.Duplicate', 'errorMessage' => 'Specified connection string or port want to be modified is the same with current net type.', ], [ 'errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', ], ], ], '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"}]', 'title' => 'ModifyDBInstanceConnectionString', '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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '97AC8948-D7E4-457E-BE03-850CF04E****', ], ], ], ], ], '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' => ' ', ], 'DescribeIntranetAttribute' => [ 'summary' => 'Queries the current bandwidth 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' => '56414', '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****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AutoRenewal' => [ 'description' => 'Indicates whether auto-renewal is enabled for the extra internal bandwidth that you purchased. Valid values:'."\n" ."\n" .'* **true**: Auto-renewal is enabled.'."\n" .'* **false**: Auto-renewal is disabled.'."\n" ."\n" .'> If no extra internal bandwidth is purchased, this parameter is not returned.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '25D42CC3-FBA1-4AEC-BCE2-B8DD3137****', ], 'ExpireTime' => [ 'description' => 'The time when the extra internal bandwidth that you purchased for temporary use 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 no extra internal bandwidth for temporary use is purchased or the extra internal bandwidth that you purchased for temporary use has expired, **0** is returned for this parameter.'."\n", 'type' => 'string', 'example' => '0', ], 'IntranetBandwidth' => [ 'description' => 'The internal bandwidth of the instance. This parameter indicates the combined bandwidth of all shards in the instance. Unit: Mbit/s.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '102', ], 'HasPrePaidBandWidthOrderRunning' => [ 'description' => 'Specifies whether the instance has unexpired bandwidth plans. Valid values:'."\n" ."\n" .'* **true**: The instance has unexpired bandwidth plans.'."\n" .'* **false**: The instance does not have unexpired bandwidth plans.'."\n" ."\n" .'> If no extra internal bandwidth is purchased, this parameter is not returned.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'BandwidthExpireTime' => [ 'description' => 'The expiration time of the purchased bandwidth. The time follows the ISO 8601 standard in the *yyyy-MM-dd* T *HH:mm:ss* Z format.'."\n" ."\n" .'> If no extra internal bandwidth is purchased, this parameter is not returned.'."\n", 'type' => 'string', 'example' => '2021-03-06T16:00:00Z', ], 'BandwidthPrePaid' => [ 'description' => 'The billing method of the bandwidth plan. Valid values:'."\n" ."\n" .'* **0**: pay-as-you-go'."\n" .'* **1**: subscription'."\n", 'type' => 'string', 'example' => '0', ], 'IntranetBandWidthBurst' => [ 'type' => 'integer', 'format' => 'int32', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n 102\\n 25D42CC3-FBA1-4AEC-BCE2-B8DD3137****\\n 2021-03-06T16:00:00Z\\n true\\n 0\\n","errorExample":""}]', 'title' => 'DescribeIntranetAttribute', 'description' => 'You can call the [EnableAdditionalBandwidth](~~473771~~) operation to increase the internal bandwidth of an instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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', ], ], ], [ '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****', ], ], [ '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****', ], ], [ '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****', ], ], [ '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', ], ], [ '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+$', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '578678678', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F0997EE8-F4C2-4503-9168-85177ED78C70', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidToken.Malformed', 'errorMessage' => 'The Specified parameter Token is not valid.', ], [ 'errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke vpc service failed.', ], [ 'errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify iz not support vpc.', ], [ 'errorCode' => 'IzNotSupportSwitchNetworkError', 'errorMessage' => 'Specify iz not support switch network.', ], [ 'errorCode' => 'VpcVerifyError', 'errorMessage' => 'VpcId is wrong.', ], [ 'errorCode' => 'VpcAndVSwitchNotChange', 'errorMessage' => 'VpcId and vSwitchId not change.', ], ], 403 => [ [ 'errorCode' => 'ResourceAlreadyExists', 'errorMessage' => 'Resource already exists.', ], [ 'errorCode' => 'InsufficientResourceCapacity', 'errorMessage' => 'ip resource is conflict with other custins.', ], [ 'errorCode' => 'VpcFreePasswordNoSupport', 'errorMessage' => 'The custins opend VPCFreePassword not support this operation.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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****', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '20C8341E-B5AD-4B24-BD82-D73241522ABF', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MissingInstanceId', 'errorMessage' => 'InstanceId is mandatory for this action.', ], [ 'errorCode' => 'MissingConnectionString', 'errorMessage' => 'ConnectionStringPrefix is mandatory for this action.', ], [ 'errorCode' => 'MissingPort', 'errorMessage' => 'Port is mandatory for this action.', ], [ 'errorCode' => 'NetTypeExists', 'errorMessage' => 'Specified net type already existed.', ], [ 'errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', ], [ 'errorCode' => 'NewSSLAlreadyEnabled', 'errorMessage' => 'new SSL have already been enabled.', ], ], 403 => [ [ 'errorCode' => 'SSLNotSupportNetType', 'errorMessage' => 'SSL instance does not support create public network.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '88F850B5-CC68-48B4-83CA-5497C3C191DE', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MissingInstanceId', 'errorMessage' => 'InstanceId is mandatory for this action.', ], [ 'errorCode' => 'MissingConnectionString', 'errorMessage' => 'CurrentConnectionString is mandatory for this action.', ], [ 'errorCode' => 'AtLeastOneNetTypeExists', 'errorMessage' => 'Current DB instance net type 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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NetTypeExists', 'errorMessage' => 'Specified net type already existed', ], [ 'errorCode' => 'InvalidConnType', 'errorMessage' => 'Specified DB instance conn type is not valid.', ], [ 'errorCode' => 'TaskHasExist', 'errorMessage' => 'The task already exists.', ], [ 'errorCode' => 'ConnectionStringAlreadyExists', 'errorMessage' => 'Specified connection string already exists in the Aliyun RDS.', ], [ 'errorCode' => 'InvalidConnectionString.Format', 'errorMessage' => 'Specified connection string is not valid.', ], [ 'errorCode' => 'DirectConnectionAlreadyExists', 'errorMessage' => 'Specified instance direct connection already exists.', ], [ 'errorCode' => 'InvalidVPCParamGroup', 'errorMessage' => 'Specified vpc param group is not valid.', ], [ 'errorCode' => 'InvalidConnectionString', 'errorMessage' => 'ConnectionString is invalid, valid regex: ^\\w+$', ], ], 403 => [ [ 'errorCode' => 'UnsupportedEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], [ 'errorCode' => 'InstanceStatus.NotSupport', 'errorMessage' => 'Instance status does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDbInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', ], ], ], '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' => ' ', ], '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NetTypeNotExists', 'errorMessage' => 'Specified net type not existed.', ], ], 403 => [ [ 'errorCode' => 'InstanceStatus.NotSupport', 'errorMessage' => 'Instance status does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDbInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', ], ], ], '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' => ' ', ], '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => 'The service. Set the value to kvstore.'."\n", 'type' => 'string', 'required' => false, 'example' => 'kvstore', 'default' => 'kvstore', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '52D901ED-E0A5-42FB-B9DB-39C295C3****', ], ], ], ], ], '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' => ' ', ], 'DescribePrice' => [ 'summary' => 'Queries the fees that you must pay when you create, upgrade, or renew 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' => '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], [ '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', ], ], [ 'name' => 'SecondaryZoneId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ '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', ], ], ], [ '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', ], ], ], [ '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', ], ], [ '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', ], ], [ '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****', ], ], [ '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' => 'Instances=[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","InstanceClass": "redis.master.small.default","Period": "1","Quantity": "1","Capacity": "4096"}]', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], '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', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3A40BE4E-1890-4972-889C-FEFA37663635', ], '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', ], 'HandlingFeeAmount' => [ 'description' => 'The service fees of the order.'."\n", 'type' => 'string', 'example' => '0.1', ], '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', ], 'DiscountAmount' => [ 'description' => 'The discount amount of the order.'."\n", 'type' => 'string', 'example' => '0.21', ], 'TradeAmount' => [ 'description' => 'The transaction price of the order.'."\n", 'type' => 'string', 'example' => '10', ], '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', ], 'CouponNo' => [ 'description' => 'The coupon ID.'."\n", 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank', ], 'Name' => [ 'description' => 'The coupon name.'."\n", 'type' => 'string', 'example' => 'test', ], 'Description' => [ 'description' => 'The coupon description.'."\n", 'type' => 'string', 'example' => 'coupondemo', ], ], ], ], ], ], 'RuleIds' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'RuleId' => [ 'description' => 'The rule IDs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The rule ID.'."\n", 'type' => 'string', 'example' => '1001199213', ], ], ], ], 'ShowDiscountInfo' => [ 'description' => 'Indicates whether the discount information is displayed.'."\n", 'type' => 'boolean', ], 'DepreciateInfo' => [ 'description' => 'The activity information.'."\n", 'type' => 'object', 'properties' => [ 'ListPrice' => [ 'description' => 'The list price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1*', ], 'OriginalStandAmount' => [ 'description' => 'The original total price displayed on the official website.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12*', ], 'CheapStandAmount' => [ 'description' => 'The new total price displayed on the official website.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9*', ], 'CheapRate' => [ 'description' => 'The price reduction rate.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30%', ], 'Differential' => [ 'description' => 'The promotional offer (displayed in the total order amount).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '**', ], 'DifferentialName' => [ 'description' => 'The name of the promotional offer.'."\n", 'type' => 'string', 'example' => 'XXXXX', ], 'MonthPrice' => [ 'description' => 'The monthly price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '**', ], 'IsContractActivity' => [ 'description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'IsShow' => [ 'description' => 'Indicates whether the price reduction rate is displayed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ContractActivity' => [ 'description' => 'The activity information.'."\n", 'type' => 'object', 'properties' => [ 'FinalPromFee' => [ 'description' => 'The total discount amount.'."\n", 'type' => 'number', 'format' => 'double', 'example' => "\n", ], 'FinalFee' => [ 'description' => 'The preferential price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => "\n", ], 'ProdFee' => [ 'description' => 'The original price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', ], 'ActivityId' => [ 'description' => 'The activity ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', ], 'OptionCode' => [ 'description' => 'The promotion code.'."\n", 'type' => 'string', 'example' => '****', ], 'ActivityName' => [ 'description' => 'The activity name.'."\n", 'type' => 'string', 'example' => 'contract promotion_order_xxx discount'."\n", ], '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' => '*****', ], ], ], ], ], ], ], ], 'StandDiscountPrice' => [ 'description' => 'The discount.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', ], 'IsContractActivity' => [ 'description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => 'false'."\n", ], 'StandPrice' => [ 'description' => 'The discounted price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0'."\n", ], 'Code' => [ 'description' => 'The order code.'."\n", 'type' => 'string', 'example' => '""'."\n", ], 'Message' => [ 'description' => 'The information about the order.'."\n", 'type' => 'string', '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' => [ 'description' => 'The title of the rule.'."\n", 'type' => 'string', 'example' => 'test', ], 'Name' => [ 'description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'test', ], ], 'description' => '', ], ], ], ], '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', ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1xxxxxxxxxxxxx', ], 'DiscountAmount' => [ 'description' => 'The discount amount of the order.'."\n", 'type' => 'string', 'example' => '0.21', ], 'TradeAmount' => [ 'description' => 'The transaction price of the order.'."\n", 'type' => 'string', 'example' => '10', ], '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', ], ], ], ], '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', ], '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', ], 'Name' => [ 'description' => 'The coupon name.'."\n", 'type' => 'string', 'example' => '****', ], 'Description' => [ 'description' => 'The description of the coupon.'."\n", 'type' => 'string', 'example' => '****', ], 'Show' => [ 'description' => 'Indicates whether the discount is displayed.'."\n", 'type' => 'boolean', 'example' => 'False', ], 'ActivityExtInfo' => [ 'description' => 'The additional activity information.'."\n", 'type' => 'object', 'example' => '****', ], 'OptionCode' => [ 'description' => 'The promotion code.'."\n", 'type' => 'string', 'example' => '****', ], 'PromotionName' => [ 'description' => 'The promotion name.'."\n", 'type' => 'string', 'example' => '****', ], 'PromotionOptionNo' => [ 'description' => 'The promotion ID.'."\n", 'type' => 'string', 'example' => 'youhuiquan_promotion_option_id_for_blank', ], 'CanPromFee' => [ 'description' => 'The amount that can be deducted by using the coupon.'."\n", 'type' => 'string', 'example' => '****', ], ], 'description' => '', ], ], ], ], 'DepreciateInfo' => [ 'description' => 'The price reduction information.'."\n", 'type' => 'object', 'properties' => [ 'ListPrice' => [ 'description' => 'The list price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', ], 'OriginalStandAmount' => [ 'description' => 'The original total price displayed on the official website.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', ], 'CheapStandAmount' => [ 'description' => 'The new total price displayed on the official website.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', ], 'CheapRate' => [ 'description' => 'The price reduction rate.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', ], 'Differential' => [ 'description' => 'The promotional offer (displayed in the total order amount).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', ], 'DifferentialName' => [ 'description' => 'The name of the promotional offer.'."\n", 'type' => 'string', 'example' => '****', ], 'MonthPrice' => [ 'description' => 'The monthly price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', ], 'IsContractActivity' => [ 'description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'ContractActivity' => [ 'description' => 'The contract promotion.'."\n", 'type' => 'object', 'properties' => [ 'FinalPromFee' => [ 'description' => 'The total discount amount.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', ], 'FinalFee' => [ 'description' => 'The preferential price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', ], 'ProdFee' => [ 'description' => 'The original price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', ], 'ActivityId' => [ 'description' => 'The activity ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1412025702634847', ], 'OptionCode' => [ 'description' => 'The promotion ID.'."\n", 'type' => 'string', 'example' => '****', ], 'ActivityName' => [ 'description' => 'The activity name.'."\n", 'type' => 'string', 'example' => '****', ], '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", ], ], ], ], ], ], 'StartTime' => [ 'description' => 'The start time of the activity.'."\n", 'type' => 'string', 'example' => '2024-11-18T00:00:00Z', ], ], ], 'StandDiscountPrice' => [ 'description' => 'The discounted price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', ], 'IsContractActivity' => [ 'description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => '****', ], 'StandPrice' => [ 'description' => 'The discounted price.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', ], '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' => '****', ], 'ModuleId' => [ 'description' => 'The module ID.'."\n", 'type' => 'string', 'example' => '****', ], 'StandPrice' => [ 'description' => 'The discounted price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', ], 'PricingModule' => [ 'description' => 'Indicates whether the item is billed.'."\n", 'type' => 'boolean', 'example' => '****', ], 'ModuleName' => [ 'description' => 'The module name.'."\n", 'type' => 'string', 'example' => '****', ], 'DiscountFee' => [ 'description' => 'The discount.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', ], 'TotalProductFee' => [ 'description' => 'The original price of the instance.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.0'."\n", ], 'NeedOrderPay' => [ 'description' => 'Indicates whether the order is paid.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'PayFee' => [ 'description' => 'The actual amount paid.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.0'."\n", ], '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' => '****', ], 'Value' => [ 'description' => 'The attribute value.'."\n", 'type' => 'string', 'example' => '****', ], 'Code' => [ 'description' => 'The attribute code.'."\n", 'type' => 'string', 'example' => '****', ], 'Name' => [ 'description' => 'The attribute name.'."\n", 'type' => 'string', 'example' => '****', ], ], ], ], ], ], 'ContractActivity' => [ 'description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => '****', ], 'DepreciateInfo' => [ 'description' => 'The price reduction information.'."\n", 'type' => 'object', 'properties' => [ 'ListPrice' => [ 'description' => 'The list price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', ], 'OriginalStandAmount' => [ 'description' => 'The original total price displayed on the official website.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', ], 'CheapStandAmount' => [ 'description' => 'The new total price displayed on the official website.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', ], 'CheapRate' => [ 'description' => 'The price reduction rate.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '******', ], 'Differential' => [ 'description' => 'The promotional offer (displayed in the total order amount).'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', ], 'DifferentialName' => [ 'description' => 'The name of the promotional offer.'."\n", 'type' => 'string', 'example' => '****', ], 'MonthPrice' => [ 'description' => 'The monthly price.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', ], 'IsContractActivity' => [ 'description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => '****', ], 'IsShow' => [ 'description' => 'Indicates whether the price reduction rate is displayed.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'StartTime' => [ 'description' => 'The start time of the activity.'."\n", 'type' => 'string', 'example' => '2024-09-23T14:00:01Z', ], ], ], ], ], ], ], ], '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' => '****', ], 'PromotionId' => [ 'description' => 'The promotion ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '****', ], 'FinalPromFee' => [ 'description' => 'The discount amount.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '****', ], 'OptionCode' => [ 'description' => 'The coupon code.'."\n", 'type' => 'string', 'example' => '****', ], 'PromType' => [ 'description' => 'The promotion type.'."\n", 'type' => 'string', 'example' => '****', ], 'ActivityExtInfo' => [ 'description' => 'The additional activity information.'."\n", 'type' => 'object', 'example' => '****', ], 'DerivedPromType' => [ 'description' => 'The derived promotion type.'."\n", 'type' => 'string', 'example' => '****', ], 'PromotionCode' => [ 'description' => 'The promotion code.'."\n", 'type' => 'string', 'example' => '****', ], ], ], ], ], ], 'ContractActivity' => [ 'description' => 'Indicates whether eligibility for the contracted discount is met.'."\n", 'type' => 'boolean', 'example' => '****', ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', ], [ 'errorCode' => 'InvalidInstances.Format', 'errorMessage' => 'The Specified parameter Instances is not valid.', ], [ 'errorCode' => 'AlreadyHadTemporaryBandwidth', 'errorMessage' => 'This instance have already had temporary bandwidth, please modify instance spec first.', ], ], ], 'responseDemo' => '[{"type":"json","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\\": true,\\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}","errorExample":""},{"type":"xml","example":"\\n \\n CNY\\n \\n \\n 0\\n 0\\n \\n \\n 0\\n \\n 3A40BE4E-1890-4972-889C-FEFA37663635\\n \\n \\n \\n \\n 0\\n 0\\n 0\\n \\n \\n \\n \\n\\n","errorExample":""}]', 'title' => 'DescribePrice', 'requestParamsDescription' => '### Additional description of the Instances parameter'."\n" ."\n" .'The following description applies only to the Instances parameter of the DescribePrice operation.'."\n" ."\n" .'|Parameter|Type|Required|Example|Description|'."\n" .'|---|---|---|---|---|'."\n" .'|RegionId|String|Yes|cn-hangzhou|The region ID.|'."\n" .'|InstanceId|String|No|r-7xv4s7q131smyx\\*\\*\\*\\*|The instance ID. This parameter is required if the OrderType parameter is set to UPGRADE or RENEW.|'."\n" .'|InstanceClass|String|Yes|redis.master.small.default|The instance type of the classic instance. For more information, see [Instance specifications](~~26350~~).|'."\n" .'|ShardClass|String|Yes|tair.rdb.2g|The instance type of the cloud-native instance. For more information, see [Instance specifications](~~26350~~).You must specify this parameter or the InstanceClass parameter.|'."\n" .'|IzNo|String|No|cn-hangzhou-b|The zone ID.|'."\n" .'|NodeType|String|No|MASTER\\_SLAVE|The node type. Valid values:
  • STAND_ALONE: standalone
  • MASTER_SLAVE (default): high availability (master-replica)
|'."\n" .'|Period|Long|No|1|The subscription duration. Unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36.|'."\n" .'|Quantity|String|No|1|The number of instances that you want to purchase. Valid values: 1 to 30. Default value: 1.|'."\n" .'|VPCId|String|No|vpc-bp1nme44gek34slfc\\*\\*\\*\\*|The virtual private cloud (VPC) ID.|'."\n" .'|VSwitchId|String|No|vsw-bp1e7clcw529l773d\\*\\*\\*\\*|The vSwitch ID.|'."\n" .'|AutoPay|String|No|true|Specifies whether to enable automatic payment. Valid values:
  • true (default)
  • false
|'."\n" .'|InstanceName|String|No|test\\_123|The instance name.|'."\n" .'|ShardCount|String|No|2|The number of shards. Default value: 1. You do not need to specify this parameter when you query standard or read/write splitting instances. This parameter applies only to cloud-native cluster instances.|'."\n" .'|ReadOnlyCount|Integer|No|2|The total number of read replicas. This parameter applies only to cloud-native read/write splitting instances.|'."\n" .'|StorageType|String|No|essd\\_pl2|The storage type of the Tair ESSD-based instance. Valid values: **essd\\_pl0**, **essd\\_pl1**, **essd\\_pl2**, and **essd\\_pl3**. When you specify this parameter, you must also specify the **Capacity** parameter. For more information, see [Specifications of ESSD/SSD-based instances](~~2527111~~).|'."\n" .'|Capacity|Long|No|512000|The disk capacity of the Tair ESSD-based instance. Unit: MB.|'."\n" ."\n" .'### Sample requests'."\n" ."\n" .'Sample request for querying a Tair cloud-native cluster instance (**Instances** not required in this scenario):'."\n" ."\n" .'```'."\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" ."\n" .'Sample request for querying a Tair ESSD-based instance of a specific storage type:'."\n" ."\n" .'```'."\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" ."\n" .'Sample request for querying a Tair cloud-native read/write splitting instance:'."\n" ."\n" .'```'."\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 for querying multiple instances:'."\n" ."\n" .'```'."\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 for renewing a Tair cloud-native cluster instance (**Instances** not required in this scenario):'."\n" ."\n" .'```'."\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" .'```', ], '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****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ '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****', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2B17D708-1D6D-49F3-B6D7-478371DD****', ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageRecordCount' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'TotalRecordCount' => [ 'description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], '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', ], 'DBInstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], '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', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IllegalParameter', 'errorMessage' => 'Specified parameter exceeds range.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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' => '', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '2084452111111', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'D622714-AEDD-4609-9167-F5DDD3D1**** ', ], ], ], ], ], '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' => ' ', ], 'TransformInstanceChargeType' => [ 'summary' => 'Changes the billing method of a Tair (Redis OSS-compatible) instance from subscription to pay-as-you-go or from pay-as-you-go to subscription.', '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 ID of the instance. You can call the [DescribeInstances](~~DescribeInstances~~) operation to query the ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration. Unit: months. Valid values: **1**, 2, 3, 4, 5, 6, 7, 8, **9**, **12**, **24**, **36**.'."\n" ."\n" .'> This parameter is valid and required only if you set the **ChargeType** parameter to **PrePaid**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic payment. Default value: true. Valid values:'."\n" ."\n" .'* **true**: Automatic payment is enabled.'."\n" .'* **false**: Automatic payment is disabled. If automatic payment is disabled, you must perform the following steps to complete the payment: In the top navigation bar of the Tair (Redis OSS-compatible) console, choose **Expenses** > **Renewal Management**. In the left-side navigation pane of the Billing Management console, click **Orders**. On the **Orders** page, find the order and complete the payment.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The new billing method. Valid values:'."\n" ."\n" .'* **PrePaid**: subscription. If you set this parameter to PrePaid, you must also specify the **Period** parameter.'."\n" .'* **PostPaid**: pay-as-you-go'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PrePaid', 'default' => '', 'enum' => [ 'PostPaid', 'PrePaid', 'POSTPAID', 'PREPAID', 'PREPAY', 'POSTPAY', ], ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. Valid values:'."\n" ."\n" .'* **true**: enables auto-renewal.'."\n" .'* **false** (default): disables auto-renewal.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* false'."\n" .'* true'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'false' => '', 'true' => '', ], 'example' => 'false', 'default' => 'false', 'enum' => [ 'true', 'false', ], ], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration that is supported by auto-renewal. Unit: month. Valid values: **1**, **2**, **3**, **6**, and **12**.'."\n" ."\n" .'> This parameter is required if the **AutoRenew** parameter is set to **true**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'default', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => 'The time when the instance expires.'."\n" ."\n" .'> A value is returned for this parameter only if the instance was changed from pay-as-you-go to subscription.'."\n", 'type' => 'string', 'example' => '2021-05-13T00:00:00Z', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '82C791FB-8979-489E-853D-706D7743****', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '20881824000****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Period is invalid', ], [ 'errorCode' => 'ResourceNotAvailable', 'errorMessage' => 'Resource you requested is not available for finance user.', ], [ 'errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account does not have enough balance.', ], [ 'errorCode' => 'Order.LatestOrderIsHanding', 'errorMessage' => 'Latest order is handing, please retry later.', ], ], 403 => [ [ 'errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'Your account has not passed the real-name authentication yet.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"EndTime\\": \\"2021-05-13T00:00:00Z\\",\\n \\"RequestId\\": \\"82C791FB-8979-489E-853D-706D7743****\\",\\n \\"OrderId\\": \\"20881824000****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 2021-05-13T00:00:00Z\\r\\n 82C791FB-8979-489E-853D-706D7743****\\r\\n 20881824000****\\r\\n","errorExample":""}]', 'title' => 'TransformInstanceChargeType', 'description' => 'Before you call this operation, make sure that you understand relevant precautions and billing rules. For more information, see the following topics:'."\n" ."\n" .'* [Change the billing method to subscription](~~54542~~).'."\n" .'* [Change the billing method to pay-as-you-go](~~211549~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ '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' => '1024', ], ], [ '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' => 'redis.master.small.default', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the promotional event or business information.'."\n", 'type' => 'string', 'required' => false, 'example' => '000000000', ], ], [ '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', ], ], [ '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' => 'TF-ModifyInstanceSpec-1686645570-7dac7257-4a14-4811-939c-51a282f', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => 'The end time of the order.'."\n", 'type' => 'string', 'example' => '2019-02-19T00:00:00Z', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2222245-222A-4155-9349-E22222****', ], 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '111111111111111', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'HasRenewChangeOrder', 'errorMessage' => 'This instance has a renewChange order.', ], ], ], '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', 'description' => 'This operation is applicable only to subscription instances.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateAccount' => [ 'summary' => 'Creates an account that has specific permissions for a 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****', ], ], [ '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', ], ], [ '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', ], ], [ '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABAF95F6-35C1-4177-AF3A-70969EBD****', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'AcountName' => [ 'description' => 'The name of the account.'."\n", 'type' => 'string', 'example' => 'demoaccount', ], 'AccountName' => [ 'title' => '', 'type' => 'string', ], ], 'title' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidAccountName.Duplicate', 'errorMessage' => 'Specified AccountName already exists in this instance.', ], [ 'errorCode' => 'InvalidAccountName.Format', 'errorMessage' => 'Specified AccountName is not valid.', ], [ 'errorCode' => 'InvalidEngineVersion.Format', 'errorMessage' => 'Current EngineVersion does not support operations.', ], [ 'errorCode' => 'InvalidAccountDescription.Format', 'errorMessage' => 'Specified AccountDescription is not valid.', ], [ 'errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified AccountPassword is not valid.', ], [ 'errorCode' => 'InvalidDBInstanceAccountMode.Format', 'errorMessage' => 'Current DB instance AccountMode does not support this operation.', ], [ 'errorCode' => 'InvalidAccountName.Forbid', 'errorMessage' => 'Specified AccountName is a keyword.', ], [ 'errorCode' => 'InvalidAccountPrivilege.Malformed', 'errorMessage' => 'Specified account privilege is not valid.', ], ], 403 => [ [ 'errorCode' => 'AccountLimitExceeded', 'errorMessage' => 'Exceeding the allowed amount of account.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ABAF95F6-35C1-4177-AF3A-70969EBD****\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"AcountName\\": \\"demoaccount\\",\\n \\"AccountName\\": \\"demoaccount\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"ABAF95F6-35C1-4177-AF3A-70969EBDF624\\",\\n \\"AcountName\\":\\"test2\\"\\n}"},{"type":"xml","example":"\\n D3876765-1983-4CBC-BB45-79EEBD6D****\\n r-bp1zxszhcgatnx****\\n demoaccount\\n","errorExample":"\\n ABAF95F6-35C1-4177-AF3A-70969EBDF624\\n test2\\n"}]', 'title' => 'CreateAccount', '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" .'* You can create up to 18 accounts for an instance.'."\n" ."\n" .'> For more information about how to create an account in the console, see [Manage database accounts](~~92665~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8129F11A-D70B-43A6-9455-CE9EAA71****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidAccountName.Format', 'errorMessage' => 'Specified AccountName is not valid.', ], [ 'errorCode' => 'InvalidEngineVersion.Format', 'errorMessage' => 'Current EngineVersion does not support operations.', ], ], 403 => [ [ 'errorCode' => 'OperationDenied.AccountStatus', 'errorMessage' => 'The operation is not permitted due to status of account.', ], ], [ [ 'errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified AccountName does not exist.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidEngineVersion.Format', 'errorMessage' => 'Current EngineVersion does not support operations.', ], [ 'errorCode' => 'InvalidAccountDescription.Format', 'errorMessage' => 'Specified AccountDescription is not valid.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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****', ], ], [ '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****', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], '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' => ' ', ], 'DescribeAccounts' => [ 'summary' => 'Queries a specified account of a Tair (Redis OSS-compatible) instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '56373', '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****', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the account that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'demoaccount', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '6C9E114C-217C-4118-83C0-B4070222****', ], 'Accounts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Account' => [ 'description' => 'Details about returned accounts of the instance.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Details about the account.'."\n", 'type' => 'object', 'properties' => [ 'AccountDescription' => [ 'description' => 'The description of the account.'."\n", 'type' => 'string', 'example' => 'testdec', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp10noxlhcoim2****', ], 'AccountType' => [ 'description' => 'The type of the account. Valid values:'."\n" ."\n" .'* **Normal**: standard account'."\n" .'* **Super**: super account'."\n", 'type' => 'string', 'example' => 'Normal', ], 'AccountStatus' => [ 'description' => 'The state of the account. Valid values:'."\n" ."\n" .'* **Unavailable**: The account is unavailable.'."\n" .'* **Available**: The account is available.'."\n", 'type' => 'string', 'example' => 'Available', ], 'AccountName' => [ 'description' => 'The name of the account.'."\n", 'type' => 'string', 'example' => 'demoaccount', ], 'DatabasePrivileges' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DatabasePrivilege' => [ 'description' => 'Details about account permissions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The permission of the account.'."\n", 'type' => 'object', 'properties' => [ 'AccountPrivilege' => [ 'description' => 'The permission 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', 'example' => 'RoleReadWrite', ], ], ], ], ], ], ], ], ], ], ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","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}","errorExample":"{\\n \\"Accounts\\":{\\n \\"Account\\":[\\n {\\n \\"DatabasePrivileges\\":{\\n \\"DatabasePrivilege\\":[\\n {\\n \\"AccountPrivilege\\":\\"RoleReadWrite\\"\\n }\\n ]\\n },\\n \\"AccountStatus\\":\\"Available\\",\\n \\"InstanceId\\":\\"r-xxxxxxxxxxxxxxx\\",\\n \\"AccountName\\":\\"r-xxxxxxxxxxxxxxx\\",\\n \\"PrivExceeded\\":\\"0\\",\\n \\"AccountType\\":\\"Normal\\"\\n }\\n ]\\n },\\n \\"RequestId\\":\\"6C9E114C-217C-4118-83C0-B40702221161\\"\\n}"},{"type":"xml","example":"\\n 4A74FE3A-2BA8-4574-AB85-99C01707****\\n \\n \\n Available\\n r-bp10noxlhcoim2****\\n Normal\\n \\n \\n RoleReadWrite\\n \\n \\n r-bp10noxlhcoim2****\\n \\n \\n \\n Available\\n r-bp10noxlhcoim2****\\n Normal\\n \\n \\n RoleReadWrite\\n \\n \\n testaccount\\n \\n \\n","errorExample":"\\n \\n \\n \\n \\n RoleReadWrite\\n \\n \\n Available\\n r-xxxxxxxxxxxxxxx\\n r-xxxxxxxxxxxxxxx\\n 0\\n Normal\\n \\n \\n 6C9E114C-217C-4118-83C0-B40702221161\\n"}]', 'title' => 'DescribeAccounts', 'description' => '> Only Tair (Redis OSS-compatible) instances of Redis 4.0 or later are supported.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ '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', ], ], [ '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****', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8BE02313-5395-4EBE-BAE7-E90A053F****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidAccountName.Duplicate', 'errorMessage' => 'Specified AccountName already exists in this instance.', ], [ 'errorCode' => 'InvalidAccountName.Format', 'errorMessage' => 'Specified AccountName is not valid.', ], [ 'errorCode' => 'InvalidEngineVersion.Format', 'errorMessage' => 'Current EngineVersion does not support operations.', ], [ 'errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified AccountPassword is not valid.', ], [ 'errorCode' => 'TaskExists', 'errorMessage' => 'Specified task have existed.', ], ], ], '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"}]', 'title' => 'ResetAccountPassword', 'description' => '> Only Tair (Redis OSS-compatible) instances of Redis 4.0 or later are supported.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3845BDF5-15A6-4444-B770-78501819****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidAccountName.Format', 'errorMessage' => 'Specified AccountName is not valid.', ], [ 'errorCode' => 'InvalidAccountPrivilege.Format', 'errorMessage' => 'Specified AccountPrivilege is not valid.', ], [ 'errorCode' => 'IncorrectAccount', 'errorMessage' => 'Current DB instance account does not support this operation.', ], [ 'errorCode' => 'IncorrectMinorVersion', 'errorMessage' => 'Current engine minor version does not support operations.', ], ], 404 => [ [ 'errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified AccountName does not exist.', ], ], ], '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', '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.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateBackup' => [ 'summary' => 'Backs up a 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****', ], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'BackupJobID' => [ 'description' => 'The ID of the backup task.'."\n", 'type' => 'string', 'example' => '1162****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2FF6158E-3394-4A90-B634-79C49184****', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"BackupJobID\\": \\"\\\\\\"1022,2480\\\\\\"\\",\\n \\"RequestId\\": \\"2FF6158E-3394-4A90-B634-79C49184****\\"\\n}","errorExample":"{\\n\\t\\"RequestId\\": \\"2D719BD9-A536-4D8B-BEA9-CD299DE2AE1B\\",\\n\\t\\"BackupJobID\\": \\"4679933\\"\\n}"},{"type":"xml","example":"\\n 2FF6158E-3394-4A90-B634-79C49184****\\n 1162****\\n","errorExample":"\\n 2D719BD9-A536-4D8B-BEA9-CD299DE2AE1B\\n 4679933\\n"}]', 'title' => 'CreateBackup', 'description' => 'You can also back up an instance in the Tair (Redis OSS-compatible) console. For more information, see [Backup and recovery](~~43886~~).', 'extraInfo' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B****', ], ], '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' => 'ModifyBackupPolicy', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ '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+$', ], ], [ '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', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BB73740C-23E2-4392-9DA4-2660C74C****', ], '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', ], 'Process' => [ 'description' => 'The progress of the backup task in percentage.'."\n", 'type' => 'string', 'example' => '0', ], 'JobMode' => [ 'description' => 'The backup mode. Valid values:'."\n" ."\n" .'* **Automated**: automatic backup'."\n" .'* **Manual**: manual backup'."\n", 'type' => 'string', 'example' => 'Manual', ], 'BackupJobID' => [ 'description' => 'The ID of the backup task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8491111', ], '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' => 'Automated', ], 'NodeId' => [ 'description' => 'The ID of the data node.'."\n", 'type' => 'string', 'example' => '****', ], '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', ], 'Progress' => [ 'description' => 'The backup progress.'."\n", 'type' => 'string', 'example' => '27', ], ], 'description' => '', ], ], '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' => '_', ], 'AuthPrincipalDisplayName' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'AuthPrincipalOwnerId' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'AuthPrincipalType' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'EncodedDiagnosticMessage' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'NoPermissionType' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'PolicyType' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], ], ], ], 'description' => '', ], ], ], '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' => ' ', ], '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'BackupRetentionPeriod' => [ 'description' => 'The retention period of the backup data. Unit: days.'."\n", 'type' => 'string', 'example' => '7', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '90B82DB7-FB28-4CC2-ADBF-1F8659F3****', ], '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', ], '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', ], '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', ], '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', ], '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' => '_', ], 'AuthPrincipalDisplayName' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'AuthPrincipalOwnerId' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'AuthPrincipalType' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'EncodedDiagnosticMessage' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'NoPermissionType' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'PolicyType' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], ], 'required' => false, ], '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', ], ], 'description' => '', ], ], ], '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' => ' ', ], 'DescribeBackups' => [ 'summary' => 'Queries the backup files of the 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' => '56385', 'abilityTreeNodes' => [ 'FEATUREkvstore6TUUNS', ], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance whose backup files you want to query.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the backup file.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11611111', ], ], [ 'name' => 'BackupJobId', 'in' => 'query', 'schema' => [ 'description' => 'The backup task ID, returned by CreateBackup. If CreateBackup returns multiple BackupJobIds, you need to use this interface to query each of them separately.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of entries per page. Valid values: 30, 50, 100, 200, and 300.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', 'enum' => [ '30', '50', '100', '200', '300', '1000', ], ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number. The value must be an integer that is greater than **0**. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ '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-11T10:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-03-14T18:00Z', ], ], [ 'name' => 'NeedAof', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable append-only files (AOFs) persistence. Valid values:'."\n" ."\n" .'* **0**: no'."\n" .'* **1**: yes'."\n" ."\n" .'> The default value is **0**.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '963C20F0-7CE1-4591-AAF3-6F3CD1CE****', ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'TotalCount' => [ 'description' => 'The total number of backup files that were returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'FullStorageSize' => [ '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 the returned backup sets. Instead, it reflects the total size of all valid full backups of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'LogStorageSize' => [ 'description' => 'The size of the log backup file of the instance. Unit: bytes. This value is valid only when flashback is enabled.'."\n" ."\n" .'> The value of this parameter is independent of the number and size of the returned backup sets. Instead, it reflects the total size of all valid log backups of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5000', ], 'FreeSize' => [ 'description' => 'This parameter does not take effect. Ignore this parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100000', ], 'Backups' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Backup' => [ 'description' => 'The queried backup sets.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The queried backup set.'."\n", 'type' => 'object', 'properties' => [ 'BackupStatus' => [ 'description' => 'The status of the backup. Valid values:'."\n" ."\n" .'* **Success**'."\n" .'* **Failed**'."\n", 'type' => 'string', 'example' => 'Success', ], 'BackupStartTime' => [ 'description' => 'The start time of the backup.'."\n", 'type' => 'string', 'example' => '2019-03-14T05:28:50Z', ], 'BackupType' => [ 'description' => 'The backup type. Valid values:'."\n" ."\n" .'* **FullBackup**'."\n" .'* **IncrementalBackup**'."\n", 'type' => 'string', 'example' => 'FullBackup', ], 'BackupDownloadURL' => [ 'description' => 'The public download URL of the backup file.'."\n", 'type' => 'string', 'example' => 'https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********', ], 'NodeInstanceId' => [ 'description' => 'The node ID.'."\n" ."\n" .'> If the instance uses the standard architecture, this parameter returns the instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp10noxlhcoim2****-db-1', ], 'BackupEndTime' => [ 'description' => 'The end time of the backup.'."\n", 'type' => 'string', 'example' => '2019-03-14T05:31:13Z', ], 'BackupId' => [ 'description' => 'The ID of the backup file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '165*****50', ], 'BackupDBNames' => [ 'description' => 'The names of the databases that are backed up. The default value is **all**, which indicates that all databases are backed up.'."\n", 'type' => 'string', 'example' => 'all', ], 'EngineVersion' => [ 'description' => 'The engine version (major version) of the instance.'."\n", 'type' => 'string', 'example' => '4.0', ], '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 instance. The ECS instance must belong to the same classic network or reside in the same virtual private cloud (VPC) as the Tair instance.', 'type' => 'string', 'example' => 'https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********', ], 'BackupSize' => [ 'description' => 'The size of the backup file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'BackupMode' => [ 'description' => 'The backup mode. Valid values:'."\n" ."\n" .'* **Automated**'."\n" .'* **Manual**'."\n", 'type' => 'string', 'example' => 'Automated', ], 'BackupMethod' => [ 'description' => 'The backup method. Valid values:'."\n" ."\n" .'* **Logical**'."\n" .'* **Physical**'."\n", 'type' => 'string', 'example' => 'Physical', ], 'BackupJobID' => [ 'description' => 'The ID of the backup task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '24340', ], 'RecoverConfigMode' => [ 'description' => 'If the backup includes account information, kernel parameters and whitelist details.', 'type' => 'string', 'example' => '{"whitelist":true,"config":true,"account":true}', ], 'ExpectExpireTime' => [ 'type' => 'string', ], ], ], ], ], ], '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' => '_', ], 'AuthPrincipalDisplayName' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'AuthPrincipalOwnerId' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'AuthPrincipalType' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'EncodedDiagnosticMessage' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'NoPermissionType' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], 'PolicyType' => [ 'description' => 'This parameter is no longer used. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '_', ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The Specified parameter StartTime is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The Specified parameter EndTime is not valid.', ], [ 'errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'The Specified EngieVersion is not valid.', ], [ 'errorCode' => 'InvalidStartTimeAndEndTime.Malformed', 'errorMessage' => 'The end time must be greater than the start time.', ], [ 'errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', ], ], ], 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n 1\\n 721E2D39-351D-40E2-BF7C-B5075B0A****\\n 30\\n 1\\n \\n \\n Physical\\n 4.0\\n http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/********\\n Automated\\n 2263040\\n 775661111\\n r-bp12fdcf4dea****\\n all\\n http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/********\\n 2020-10-30T17:31:26Z\\n 2020-10-30T17:28:28Z\\n FullBackup\\n 27717\\n Success\\n \\n \\n","errorExample":""}]', 'title' => 'DescribeBackups', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'RestoreInstance' => [ 'summary' => 'Restores the data in a backup file to a specified Tair (Redis OSS-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.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ '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, 'docRequired' => false, 'example' => '78241****', 'default' => '0', ], ], [ 'name' => 'RestoreType', 'in' => 'query', 'schema' => [ 'description' => 'The restoration mode. Valid values:'."\n" ."\n" .'* **0** (default): The parameter is invalid.'."\n" .'* **1**: restores data to a specified point in time. You can specify this value only if the [data flashback](~~148479~~) feature is enabled for the instance. If you specify this value, you also need to set the **RestoreTime** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'pattern' => '^\\d+$', 'default' => '0', 'enum' => [ '0', '1', ], ], ], [ 'name' => 'RestoreTime', 'in' => 'query', 'schema' => [ 'description' => 'The point in time to which you want to restore data. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.'."\n" ."\n" .'> The point in time cannot be earlier than the point in time when the data flashback feature is enabled.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-07-06T07:25:57Z', ], ], [ 'name' => 'FilterKey', 'in' => 'query', 'schema' => [ 'description' => 'The key that you want to restore. You can specify multiple keys. Separate multiple keys with commas (,). Regular expressions are supported.'."\n" ."\n" .'* If you do not specify this parameter, the entire instance is restored.'."\n" .'* If you specify this parameter, only the involved keys are restored. Only classic instances support this feature.'."\n" ."\n" .'> In a regular expression, an asterisk (`*`) matches zero or more occurrences of a subexpression that occurs before. For example, if you set this parameter to `h.*llo`, strings such as `hllo` and `heeeello` are matched.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key:00000007198*', ], ], [ 'name' => 'TimeShift', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => 'When you restore a classic instance, regardless of whether you choose to restore all data or specific keys, you can apply an offset to the expiration time of the keys. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. A key expires after the remaining validity period of the key elapses based on the expiration offset time point.'."\n" ."\n" .'> '."\n" ."\n" .'* This feature applies only to keys and does not work on elements in the self-developed data structures of Tair, such as fields in exHash and skeys in TairTS.'."\n" ."\n" .'* This time point must be between the specified flashback time point and the submission time of the data restoration task.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-07-06T08:25:57Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ServiceNotSupport', 'errorMessage' => 'This service not supported.', ], [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'Missing Required Param: BackupId or RestoreTime or RestoreType.', ], [ 'errorCode' => 'ResroreParamNotMatch', 'errorMessage' => 'restoreType is not match with backupId or restoreTime.', ], [ 'errorCode' => 'InvalidRestoreTime.Format', 'errorMessage' => 'Specified restore time is not valid.', ], [ 'errorCode' => 'ZoneMigrationError.StillingRunning', 'errorMessage' => 'Zone migration task is still running', ], [ 'errorCode' => 'InvalidBinlog.NotValid', 'errorMessage' => 'The available binlog is not valid in recovery time.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B****\\"\\n}","errorExample":"{\\n\\"RequestId\\" : \\"AFA391BF-808F-4DA6-80A2-A382108A0945\\"\\n}"},{"type":"xml","example":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B****\\n","errorExample":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B3E76\\n"}]', 'title' => 'RestoreInstance', 'description' => '* If your instance is a [DRAM-based instance](~~126164~~) or a [persistent memory-optimized instance](~~183956~~) and has the [data flashback](~~148479~~) feature enabled, you can call this operation to restore the entire instance or specific keys to a specific point in time accurate to the second. This way, you can achieve more fine-grained data restoration.'."\n" .'* For other types of instances, we recommend that you call the [CreateInstance](~~473757~~) or [CreateTairInstance](~~473770~~) operation to restore the backup data to a new instance.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeClusterBackupList' => [ 'summary' => 'Queries the backup sets 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', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-t4nj72oug5r5646qog', ], ], [ 'name' => 'ClusterBackupId', 'in' => 'query', 'schema' => [ 'description' => 'The backup set ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cb-hyxdof5x9kqbtust'."\n", ], ], [ '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', ], ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ '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' => '2018-12-03T07:01Z', ], ], [ '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' => '2021-05-13T00:00:00Z', ], ], [ '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', ], ], ], ], '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' => 'MaxResults本次请求所返回的最大记录条数', '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' => '集群备份集是否有效，子节点的备份集未完成或者失败时，为0', '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' => '集群备份集ID', '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', ], 'ClusterBackupEndTime' => [ 'description' => 'The end time of the backup.'."\n", 'type' => 'string', 'example' => '2024-01-10T17:21:55Z', ], 'ClusterBackupMode' => [ 'description' => 'The backup mode.'."\n", 'type' => 'string', 'example' => 'Automated', ], 'ShardClassMemory' => [ 'title' => '做全量备份时，当时单个DB节点的内存规格大小，单位为MB', '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', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'hins100322105_data_20240108012127.rdb', ], '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', ], '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', ], 'RecoverConfigMode' => [ 'description' => 'This parameter does not take effect. Ignore this parameter.'."\n", 'type' => 'string', 'example' => 'null', ], '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', ], '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', ], 'BackupSize' => [ 'description' => 'The size of the backup file. Unit: bytes.'."\n", 'type' => 'string', 'example' => '1024', ], 'IsAvail' => [ 'description' => 'Indicates whether the backup set is available. Valid values:'."\n" ."\n" .'* **0**: unavailable'."\n" .'* **1**: available'."\n", 'type' => 'string', 'example' => '1', ], 'BackupStatus' => [ 'description' => 'The status of the backup. Valid values:'."\n" ."\n" .'* **OK**'."\n" .'* **ERROR**'."\n", 'type' => 'string', 'example' => 'OK', ], 'BackupName' => [ 'description' => 'The name of the backup.'."\n", 'type' => 'string', 'example' => 'hins100322105_data_20240110012135.rdb', ], 'Engine' => [ 'description' => 'The database engine. The return value is **redis**.'."\n", 'type' => 'string', 'example' => 'redis', ], 'ExtraInfo' => [ 'description' => 'The additional information.'."\n", 'type' => 'object', 'properties' => [ 'CustinsDbVersion' => [ 'description' => 'The engine version.'."\n", 'type' => 'string', 'example' => '5.0', ], ], ], ], ], ], 'Progress' => [ 'title' => '备份进度，仅正在运行的备份才会显示进度', 'description' => 'The backup progress. The system displays only the progress of running backup tasks.'."\n", 'type' => 'string', 'example' => '100%', ], 'ExpectExpireTime' => [ 'type' => 'string', ], ], ], ], ], ], ], ], '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' => 'DescribeClusterBackupList', 'description' => 'This operation is applicable only to cloud-native instances.'."\n", ], '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Interval' => [ 'description' => 'The collection frequency of the monitoring data. Unit: second.'."\n", 'type' => 'string', 'example' => '5', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '276F582D-C6B2-519C-A5ED-2A92BB15EC07', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Interval\\": \\"5\\",\\n \\"RequestId\\": \\"276F582D-C6B2-519C-A5ED-2A92BB15EC07\\"\\n}","type":"json"}]', 'title' => 'DescribeDBInstanceMonitor', ], '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****', ], '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', ], 'MonitorKey' => [ 'description' => 'The metric.'."\n", 'type' => 'string', 'example' => 'select', ], ], ], ], ], ], ], ], ], ], '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' => ' ', ], 'DescribeHistoryMonitorValues' => [ 'summary' => 'Queries the performance monitoring data 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' => '56402', 'abilityTreeNodes' => [ 'FEATUREkvstoreW1V0SW', ], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ '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' => '2022-11-06T00:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. Specify the time in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.'."\n" ."\n" .'> You can query the monitoring data of the previous month. The maximum time range that you can specify for a query is seven days.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2022-11-06T00:30:00Z', ], ], [ 'name' => 'IntervalForHistory', 'in' => 'query', 'schema' => [ 'description' => 'This parameter is deprecated. Set the value to `01m`.'."\n" ."\n" .'The **interval at which a query is performed** is automatically determined based on the start time and end time of the query. For example, if the query time range is less than or equal to 10 minutes, data is aggregated at a frequency of every 5 seconds and the results are returned at 5-second intervals.'."\n" ."\n" .'> * The query result is aligned with the data aggregation frequency. If the specified StartTime value does not coincide with a point in time for data aggregation, the system returns the latest point in time for data aggregation as the first point in time. For example, if you set the StartTime parameter to 2022-01-20T12:01:48Z, the first point in time returned is 2022-01-20T12:01:45Z.'."\n" .'> * If the number of data shards is greater than or equal to 32, the minimum data aggregation frequency is 1 minute.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '01m', 'enum' => [ '01m', '05m', '15m', '60m', ], ], ], [ 'name' => 'MonitorKeys', 'in' => 'query', 'schema' => [ 'description' => 'The monitoring metrics. Separate the metrics with commas (,). Take CpuUsage as an example:'."\n" ."\n" .'* Cluster or read/write splitting instances'."\n" ."\n" .' * To query the overall CPU utilization of all data nodes, specify **CpuUsage$db**.'."\n" .' * To query the CPU utilization of a single data node, specify **CpuUsage** and NodeId.'."\n" ."\n" .'* Standard master-replica instances: Specify only **CpuUsage**.'."\n" ."\n" .'For more information about monitoring metrics and their descriptions, see [Additional description of MonitorKeys](https://www.alibabacloud.com/help/zh/redis/developer-reference/api-r-kvstore-2015-01-01-describehistorymonitorvalues-redis#monitorKeys-note).'."\n" ."\n" .'> * This parameter is empty by default, which indicates that the UsedMemory and quotaMemory metrics are returned.'."\n" .'> * To ensure query efficiency, we recommend that you specify no more than five metrics for a single node at a time, and specify only a single metric when you query aggregate metrics.', 'type' => 'string', 'required' => false, 'example' => 'memoryUsage', ], ], [ 'name' => 'NodeId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the node in the instance. You can set this parameter to query the data of a specified node.'."\n" ."\n" .'* This parameter is available only for read/write splitting or cluster instances of Tair.'."\n" ."\n" .'* You can call the [DescribeLogicInstanceTopology](~~473786~~) operation to query node IDs.', 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****-db-0#1679****', ], ], [ 'name' => 'NodeRole', 'in' => 'query', 'schema' => [ 'description' => 'If you want to query the metrics of the read replicas in a cloud-native read/write splitting instance, you must set this parameter to **READONLY** and specify **NodeId**.'."\n" ."\n" .'> In other cases, you do not need to specify this parameter or you can set this parameter to **MASTER**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'READONLY', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'MonitorHistory' => [ 'description' => 'The monitoring information returned in the JSON format. For more information, see [View performance monitoring data](~~122091~~).'."\n" ."\n" .'* Only metrics whose values are not 0 are returned. This improves data transmission efficiency. Metrics that are not displayed are represented by the **0** default value.'."\n" ."\n" .'* The query result is aligned with the data aggregation frequency. If the specified time range to query is less than or equal to 10 minutes and the data is aggregated once every 5 seconds, query results are returned at an interval of 5 seconds. If the specified StartTime value does not coincide with a point in time for data aggregation, the system returns the latest point in time for data aggregation as the first point in time. For example, if you set the StartTime parameter to 2022-01-20T12:01:48Z, the first point in time returned is 2022-01-20T12:01:45Z.', '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\\"}}"', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F0997EE8-F4C2-4503-9168-85177ED7****', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The Specified parameter "StartTime" is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The Specified parameter "EndTime" is not valid.', ], ], ], 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n {\\"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 88523C30-8416-56E8-AAEF-64F849803C7C\\n","errorExample":""}]', 'title' => 'DescribeHistoryMonitorValues', 'description' => 'You can also query the performance monitoring data of an instance in the Tair console. For more information, see [Metrics](~~43887~~).', 'requestParamsDescription' => '

Additional description of MonitorKeys

'."\n" ."\n" .'When you call the operation, you must specify the parameters in the MonitorKeys column of the following table. The system returns submetrics. General monitoring metrics and command-related monitoring metrics are available for instances.'."\n" .'#### General monitoring metrics'."\n" .'In this example, the CpuUsage metric is used to describe how to use a general monitoring metric.'."\n" .'* Cluster or read/write splitting instances:'."\n" .'
  • To query the overall CPU utilization of all data nodes, you must specify CpuUsage$db.
  • To query the CPU utilization of all proxy nodes, you must specify CpuUsage$proxy.
  • To query the CPU utilization of a single data node or proxy node, you must specify CpuUsage and NodeId.
'."\n" ."\n" .'* Standard master-replica instances: Specify only **CpuUsage**.'."\n" ."\n" .'

MonitorKeys

Submetric

Unit

Description

Applicable scope

CpuUsage

CpuUsage

%

The CPU utilization. Valid values: 0 to 100.

If the RedisCpuUsage parameter is specified or returned for your instance in the previous request, you can continue to use the parameter.

  • DB

  • Database aggregation

  • Proxy

  • Proxy node aggregation

MemoryUsage

memoryUsage

%

The memory usage.

  • DB

  • Database aggregation

quotaMemory

quotaMemory

Bytes

The total memory of the data shard.

  • DB

  • DB aggregation

UsedMemory

UsedMemory

Bytes

The amount of used memory, which includes the memory consumed by data and cache.

  • DB

  • DB aggregation

Tair_PmemUsage

PmemUsage

%

The Persistent Memory (PMem) usage, the amount of PMem used, and the total amount of PMem.

These submetrics are available only for persistent memory-optimized instances.

  • DB

  • DB aggregation

Tair_Pmem

PmemUsed

Bytes

PmemQuota

Bytes

Redis_DetailedSpaceUsage

ins_size

MB

The total disk space used by the instance, the disk space used by data files such as append-only files (AOFs) and Redis Database (RDB) files, and the disk space used by logs such as active logs. These submetrics are available only for DRAM-based instances that are deployed in classic (local disk-based) mode.

  • DB

  • DB aggregation

data_size

MB

log_size

MB

Redis_Memory_Monitor

used_memory_rss

Bytes

The physical memory used by the process, which is the memory allocated by the operating system to Tair.

  • DB

used_memory_lua

Bytes

The amount of memory used by Lua scripts.

used_memory_startup

Bytes

The amount of memory used by Tair during startup.

lazyfree_pending_objects

Counts

The number of keys pending to be reclaimed when Tair performs lazy free operations.

used_memory_overhead

Bytes

The amount of memory that is used to support the internal mechanisms of Tair for maintaining datasets, including the output buffers, query buffers, and AOFs for all clients.

used_memory_dataset

Bytes

The amount of memory used by data.

UsedQPS

TotalQps

Counts/s

The total number of requests per second, including both read and write requests.

  • DB

  • DB aggregation

  • Proxy

  • Proxy aggregation

GetQps

Counts/s

The number of read requests per second and the number of write requests per second. These submetrics are available only for instances that run Redis 4.0 or later.

PutQps

Counts/s

OtherOps

Counts/s

The number of non-read/write requests per second, such as PING, INFO, SELECT, and AUTH requests. For instances that contain proxy nodes, the OtherOps submetric indicates only the number of INFO requests per second.

ConnectionUsage

connectionUsage

%

The connection usage, which is calculated by using the following formula: Number of used connections/Number of total supported connections. When the client connects to the cluster instance by using a private endpoint, this submetric is meaningful.

  • DB

  • DB aggregation

UsedConnection

ConnCount

Counts

The number of used connections.

QPSUsage

qpsUsage

%

The queries per second (QPS) usage.

  • DB

IntranetIn

InFlow

KB/s

The inbound and outbound traffic rates.

  • DB

  • DB aggregation

  • Proxy

  • Proxy aggregation

IntranetOut

OutFlow

KB/s

IntranetInRatio

intranetInRatio

%

The inbound and outbound traffic usage.

  • DB

  • DB aggregation

IntranetOutRatio

intranetOutRatio

%

Redis_Avg_Rt_Monitor

AvgRt

us

The average response time of all commands, which indicates the average time that is measured from the time when a data node receives a command to the time when the data node returns the command output.

  • This metric for a DB node does not include the response time of the proxy node and load balancing.
  • This metric for a proxy node includes the response time of the DB and proxy nodes but not the time for load balancing.

  • DB

  • DB aggregation

  • Proxy

  • Proxy aggregation

Redis_Max_Rt_Monitor

MaxRt

us

The maximum latency for commands, which indicates the maximum time period from the time when the replica node receives a command to the time when the replica node returns the command output.

  • This metric for a DB node does not include the response time of the proxy node and load balancing.
  • This metric for a proxy node includes the response time of the DB and proxy nodes but not the time for load balancing.

Redis_Basic_Monitor

Keys

Counts

The total number of keys, which indicates the number of primary keys stored in the instance.

  • DB

  • DB aggregation

Expires

Counts

The number of keys that has a time to live (TTL) value configured. This submetric displays the instantaneous value when data is collected.

ExpiredKeys

Counts

The total number of expired keys.

EvictedKeys

Counts

The total number of evicted keys.

ExpiredKeysPerSecond

Counts/s

The number of keys that are expired per second.

EvictedKeysPerSecond

Counts/s

The number of keys that are evicted per second.

inmem_keys

Counts

These submetics are available only for hybrid-storage instances (phased out). You can ignore these submetrics.

swapped_keys

Counts

Hit_Rate_Monitor

hit_rate

%

The hit ratio of keys, which is calculated by using the following formula: Total key hits/(Total key hits + Total key misses).

  • DB

  • DB aggregation

hit

Counts

The number of key hits per second.

miss

Counts

The number of key misses per second.

evicted_keys_per_sec

Counts

The number of keys that are evicted per second.

DiskUsage

disk_usage

%

The disk space usage, the size of the input buffer, the size of the output buffer, and the monitoring metrics related to disk performance. These submetics are available only for ESSD/SSD-based instances.

  • DB

RocksDBConn

Tair_Connection_Monitor

Bytes

Tair_Connection_Monitor

Bytes

Tair_Disk_Monitor

Submetrics such as io_bandwidth_kbps, iops, and iops_usage

UsedConnection

ConnectionUsage

%

The connection usage, which is calculated by using the following formula: Number of used connections/Number of total supported connections. When the client connects to the cluster or read/write splitting instance by using a proxy node, this submetric is meaningful.

  • Proxy

  • Proxy aggregation

UsedConnection

Counts

The number of used connections.

NewUserConnQps

Counts/s

The number of connections that are established per second from clients to proxy nodes.

Redis_Package_Monitor

request

Byte

The average bytes of a single request.

  • Proxy

response

Byte

The average bytes of a single response.

request_max

Byte

The maximum bytes of a single request.

response_max

Byte

The maximum bytes of a single response.

RedisProxyConn

RedisUsedConnection

Counts

The number of connections that are established from proxy nodes to data nodes.

NewDBConnQps

Counts/s

The number of connections that are established per second from proxy nodes to data nodes.

DisconnectDBConn

Counts

The cumulative number of disconnections from proxy nodes to data nodes.

DisconnectUserConn

Counts

The cumulative number of disconnections from clients to proxy nodes.

TotalCalls

TotalRefusedCommands

Counts

The cumulative number of rejected commands.

TotalCallsPerSecCalls

Counts/s

The QPS.

TotalCallsPerSecRetryCalls

Counts/s

The number of request retries per second.

TotalCallsPerSecRetryFailed

Counts/s

The number of failed requests per second.

'."\n" ."\n" .'
'."\n" .'Command-related monitoring metrics (expand to view the metrics)'."\n" .'Command-related monitoring metrics are supported only when you query a specific database. When you query the monitoring data of a specific database, you must specify the MonitorKeys and NodeId parameters.'."\n" ."\n" .'> Monitoring metrics related to extended data structures of Tair are available only for DRAM-based instances that are deployed in classic (local-disk based) mode.'."\n" .'

MonitorKeys

Submetric

Unit

Description

Redis_Keys_Monitor

del, dump, exists, expire, expireat, move, persist, pexpire, pexpireat, pttl, randomkey, rename, renamenx, restore, sort, ttl, type, and scan

Counts/s

The monitoring information about the use of key-value related commands, such as the number of times that DEL and EXISTS are executed per second.

Redis_String_Monitor

append, bitcount, bitop, decr, decrby, get, getbit, getrange, getset, incr, incrby, incrbyfloat, mget, mset, msetnx, psetex, set, setbit, setex, setnx, setrange, and strlen

Counts/s

The monitoring information about the use of string-related commands, such as the number of times APPEND and MGET are executed per second.

Redis_Hashes_Monitor

hdel, hexists, hget, hgetall, hincrby, hincrbyfloat, hkeys, hlen, hmget, hmset, hset, hsetnx, hvals, and hscan

Counts/s

The monitoring information about the use of hash-related commands, such as the number of times HGET and HDEL are executed per second.

Redis_Lists_Monitor

blpop, brpop, brpoplpush, lindex, linsert, llen, lpop, lpush, lpushx, lrange, lrem, lset, ltrim, rpop, rpoplpush, rpush, and rpushx

Counts/s

The monitoring information about the use of list-related commands, such as the number of times BLPOP and BRPOP are executed per second.

Redis_Sets_Monitor

sadd, scard, sdiff, sdiffstore, sinter, sinterstore, sismember, smembers, smove, spop, srandmember, srem, sunion, sunionstore, and sscan

Counts/s

The monitoring information about the use of set-related commands, such as the number of times that SADD and SCARD are executed per second.

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, and bzpopmax

Counts/s

The monitoring information about the use of zset-related commands, such as the number of times that ZADD and ZCARD are executed per second.

Redis_Hyperlog_Monitor

pfadd, pfcount, and pfmerge

Counts/s

The monitoring information about the use of HyperLogLog-related commands, such as the number of times that PFADD and PFCOUNT are executed per second.

Redis_Pub_Sub_Monitor

psubscribe, publish, pubsub, punsubscribe, subscribe, and unsubscribe

Counts/s

The monitoring information about the use of commands related to the Pub/Sub command group, such as the number of times that PUBLISH and SUBSCRIBE are executed per second.

Redis_Transaction_Monitor

discard, exec, multi, unwatch, and watch

Counts/s

The monitoring information about the use of transaction-related commands, such as the number of times that WATCH and MULTI are executed per second.

Redis_Scripting_Monitor

eval, evalsha, and script

Counts/s

The monitoring information about the use of scripting-related commands, such as the number of times that EVAL and EVALSHA are executed per second.

Calls_Monitor

flushall_calls, flushdb_calls, and keys_calls

Counts

The cumulative number of times that FLUSHALL, FLUSHDB, KEYS are executed per second.

Redis_Connection_Monitor

auth, echo, ping, quit, and select

Counts/s

The monitoring information about the use of connection-related commands, such as the number of times AUTH and ECHO are executed per second.

Redis_Server_Monitor

bgsave, client, command, config, dbsize, debug, flushall, flushdb, info, monitor, slowlog, and time

Counts/s

The monitoring information about the use of server-related commands, such as the number of times BGSAVE and CONFIG are executed per second.

Redis_TairDoc_Monitor

jsondel, jsonget, jsonmget, jsonset, jsontype, jsonnumincrby, jsonstrappend, jsonstrlen, jsonarrappend, jsonarrpop, jsonarrinsert, jsonarrlen, and jsonarrtrim

Counts/s

The monitoring information about the use of Doc-related commands, such as the number of times JSON.SET and JSON.GET are executed per second.

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, and exhscan

Counts/s

The monitoring information about the use of exHash-related commands, such as the number of times EXHSET and EXHMSET are executed per second.

Redis_TairString_Monitor

cas, cad, exset, exget, exsetver, exincrby, exincrbyfloat, excas, and excad

Counts/s

The monitoring information about the use of exString-related commands, such as the number of times EXSET and EXGET are executed per second.

Redis_TairGis_Monitor

gisadd, gisget, gisdel, gissearch, giscontains, gisintersects, and gisgetall

Counts/s

The monitoring information about the use of GIS-related commands, such as the number of times GIS.ADD, GIS.GET, and GIS.DEL are executed per second.

Redis_TairBloom_Monitor

bfadd, bfmadd, bfexists, bfmexists, bfinsert, bfreserve, and bfdebug

Counts/s

The monitoring information about the use of Bloom-related commands, such as the number of times BF.RESERVE and BF.ADD are executed per second.

'."\n" .'
', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRetention', 'errorMessage' => 'The Retention is invalid.', ], [ 'errorCode' => 'ResourceConfigError', 'errorMessage' => 'The request processing has failed due to resource config error.', ], ], 403 => [ [ 'errorCode' => 'TaskHasExist', 'errorMessage' => 'The task already exists.', ], ], ], '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' => ' ', ], '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', ], ], [ '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Retention' => [ 'description' => 'The retention period of audit logs. Unit: days.'."\n", 'type' => 'string', 'example' => '5', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', ], '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', ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The InstanceId provided does not exist in our records.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => 'The end time of the query.'."\n", 'type' => 'string', 'example' => '2019-03-25T12:10:00Z', ], 'StartTime' => [ 'description' => 'The start time of the query.'."\n", 'type' => 'string', 'example' => '2019-03-24T12:10:00Z', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9F5EB478-824E-4AC4-8D2B-58F31A02****', ], 'InstanceName' => [ 'description' => 'The name of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'TotalRecordCount' => [ 'description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '22222', ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The maximum number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], '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', ], 'SQLText' => [ 'description' => 'The command that was run.'."\n", 'type' => 'string', 'example' => 'CONFIG GET maxmemory', ], 'DatabaseName' => [ 'description' => 'The database name.'."\n", 'type' => 'string', 'example' => 'demo', ], 'SQLType' => [ 'description' => 'The type of the command.'."\n", 'type' => 'string', 'example' => 'non_read_write', ], 'ExecuteTime' => [ 'description' => 'The time when the command was run.'."\n", 'type' => 'string', 'example' => '2019-03-25T03:22:08Z', ], 'TotalExecutionTimes' => [ 'description' => 'The amount of time consumed to run the command.'."\n", 'type' => 'string', 'example' => '0', ], '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', ], 'AccountName' => [ 'description' => 'The username of the account.'."\n", 'type' => 'string', 'example' => 'demo', ], 'IPAddress' => [ 'description' => 'The IP address of the instance.'."\n", 'type' => 'string', 'example' => '192.16.100.***', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IncorrectDBInstance.NotSupported', 'errorMessage' => 'This instance do not support log audit.', ], [ 'errorCode' => 'InvalidEndTime.Invalid', 'errorMessage' => 'pecified end time is before this service active time.', ], [ 'errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The Specified parameter StartTime is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The Specified parameter EndTime is not valid.', ], [ 'errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', ], [ 'errorCode' => 'InvalidPageNumbers.Malformed', 'errorMessage' => 'Specified page number is not valid.', ], [ 'errorCode' => 'InvalidQueryTime.Format', 'errorMessage' => 'Specified query time is not valid.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ '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', ], ], ], [ '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', ], ], ], [ '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', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', ], ], [ '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', ], ], ], [ 'name' => 'QueryKeyword', 'in' => 'query', 'schema' => [ 'description' => 'The keyword that is used to query operational logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aof', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'StartTime' => [ 'description' => 'The beginning of the time range to query.'."\n", 'type' => 'string', 'example' => '2018-12-03T07:01Z', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '093B8579-9264-43A0-ABA9-AA86****', ], 'PageRecordCount' => [ 'description' => 'The number of log entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'PageSize' => [ 'description' => 'The maximum number of entries returned on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'Engine' => [ 'description' => 'The type of the database engine.'."\n", 'type' => 'string', 'example' => 'Redis', ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], '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', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'Content' => [ 'description' => 'The content of the log.'."\n", 'type' => 'string', 'example' => 'CONFIG REWRITE executed with success.', ], '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', ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The Specified parameter StartTime is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The Specified parameter EndTime is not valid.', ], [ 'errorCode' => 'InvalidPageSize.Malformed', 'errorMessage' => 'The specified parameter PageSize is not valid.', ], ], 404 => [ [ 'errorCode' => 'InvalidDbInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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', ], ], [ '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:11Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query. The end time must be later than the start time. 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-22T14:11Z', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ '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', ], ], ], [ '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', ], ], [ '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', ], ], ], [ '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', ], ], [ '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', ], ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'StartTime' => [ 'description' => 'The start time of the query.'."\n", 'type' => 'string', 'example' => '2019-03-10T13:11Z', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '686BB8A6-BBA5-47E5-8A75-D2ADE433****', ], 'PageRecordCount' => [ 'description' => 'The number of log entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalRecordCount' => [ 'description' => 'The total number of returned log entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The maximum number of log entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp10n********', ], 'Engine' => [ 'description' => 'The database engine that the instance runs.'."\n", 'type' => 'string', 'example' => 'Redis', ], 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], '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', ], 'ElapsedTime' => [ 'description' => 'The amount of time consumed to execute the slow query statement. Unit: microseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '248', ], 'Command' => [ 'description' => 'The slow query statement.'."\n", 'type' => 'string', 'example' => 'KEYS *', ], 'DBName' => [ 'description' => 'The database name.'."\n", 'type' => 'string', 'example' => '-1', ], '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-20T09:18:41Z', ], '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' => '-1', ], 'NodeId' => [ 'description' => 'The node ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****-db-0', ], 'AccountName' => [ 'description' => 'The username of the account.'."\n", 'type' => 'string', 'example' => 'demo', ], 'IPAddress' => [ 'description' => 'The IP address of the client.'."\n", 'type' => 'string', 'example' => '172.16.88.***', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The Specified parameter StartTime is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The Specified parameter EndTime is not valid.', ], ], 403 => [ [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], [ 'errorCode' => 'ServerBusy', 'errorMessage' => 'server busy now, please retry later.', ], ], ], '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' => ' ', ], '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', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], 'description' => '', ], ], ], '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' => ' ', ], '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', ], ], [ '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', ], ], ], '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', ], 'RequestId' => [ 'description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => '90B82DB7-FB28-4CC2-ADBF-1F8659F3****', ], ], 'description' => '', ], ], ], '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", ], '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****', ], ], [ '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.***', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AAAF99B1-69ED-4E80-8CD5-272C09E4****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Forbbiden.MinorVersion', 'errorMessage' => 'The operation is not permitted for current minor version. ', ], [ 'errorCode' => 'InvalidGroupName.Format', 'errorMessage' => 'Sepecified group name is not valid.', ], [ 'errorCode' => 'LockTimeout', 'errorMessage' => 'The request processing has failed due to lock timeout.', ], ], 404 => [ [ 'errorCode' => 'InvalidSecurityIPList.NotFound', 'errorMessage' => 'Specified same security IP does not exist or at least one security IP need.', ], ], 409 => [ [ 'errorCode' => 'SecurityIPList.Duplicate', 'errorMessage' => 'Specified same security IP already exists.', ], ], ], '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' => ' ', ], '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****', ], ], [ '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '147CAC09-E8C6-43F8-9599-982A43D6****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'EngineNotSupported', 'errorMessage' => 'Engine specified cannot be supported the operation.', ], [ 'errorCode' => 'AssociatedEcsSecurityGroupIdQuotaExceed', 'errorMessage' => 'SecurityGroupId参数超过能使用的最大数量.', ], [ 'errorCode' => 'MissingInstanceId', 'errorMessage' => 'InstanceId is mandatory for this action.', ], [ 'errorCode' => 'InvalidParam', 'errorMessage' => 'Specified ecs security group id is not valid.', ], [ 'errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'the Specified Zone not supported.', ], ], 403 => [ [ 'errorCode' => 'AssociatedEcsSecurityGroupId.QuotaExceed', 'errorMessage' => 'SecurityGroupIdQuotaExceeded exceeding the allowed amount of SecurityGroupId.', ], ], [ [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter “DBInstanceId” that is mandatory for processing this request is not supplied.', ], [ 'errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', ], [ 'errorCode' => 'InvalidRegionZoneNotFound', 'errorMessage' => 'Specified Region does not exist in RDS.', ], ], ], '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' => ' ', ], 'ModifyInstanceSSL' => [ 'summary' => 'Enables Transport Layer Security (TLS) for a Tair (Redis OSS-compatible) instance.', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '56487', 'abilityTreeNodes' => [ 'FEATUREkvstoreJ7QDWH', 'FEATUREkvstore4XSUU7', 'FEATUREkvstoreDER7E8', 'FEATUREkvstoreZ21KYW', ], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'SSLEnabled', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable TLS (SSL) encryption. Valid values:'."\n" ."\n" .'* **Disable**: disables SSL encryption.'."\n" .'* **Enable**: enables SSL encryption.'."\n" .'* **Update**: updates the SSL certificate.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Enable', 'enum' => [ 'Disable', 'Enable', 'Update', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AD7E16AA-6B23-43BF-979C-07D957FB****', ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '32184****', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', ], ], 403 => [ [ 'errorCode' => 'IncorrectCharacterType', 'errorMessage' => 'Current DB instance CharacterType does not support this operation.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], [ 'errorCode' => 'IncorrectDBInstanceState', 'errorMessage' => 'Current DB instance state does not support this operation.', ], [ 'errorCode' => 'IncorrectDBInstanceLockMode', 'errorMessage' => 'Current DB instance lock mode does not support this operation.', ], ], [ [ 'errorCode' => 'EnabledSSLNotSupport', 'errorMessage' => 'Specified region does not support enable ssl.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AD7E16AA-6B23-43BF-979C-07D957FB****\\",\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"TaskId\\": \\"32184****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 32184****\\n AD7E16AA-6B23-43BF-979C-07D957FB****\\n r-bp1zxszhcgatnx****\\n","errorExample":"\\n r-xxxxxxxxxxxxxxx\\n 52D901ED-E0A5-42FB-B9DB-39C295C37738\\n 111\\n"}]', 'title' => 'ModifyInstanceSSL', '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.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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.', '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****', ], ], [ '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', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ABAF95F6-35C1-4177-AF3A-70969EBD****', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'ParamNotSupportedForCurrentVersion', 'errorMessage' => 'Parameter is not supported for current version.', ], ], ], '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"}]', 'title' => 'ModifyInstanceVpcAuthMode', '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' => ' ', ], '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EFC9161F-15E3-4A6E-8A99-C09916D1****', ], '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', ], '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.***', ], 'SecurityIpGroupName' => [ 'description' => 'The name of the whitelist.'."\n", 'type' => 'string', 'example' => 'default', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The InstanceId provided does not exist in our records.', ], ], ], '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' => ' ', ], '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '981C0D6A-D9DD-466C-92DA-F29DF755****', ], '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****', ], 'RegionId' => [ 'description' => 'The ID of the region where the instance is deployed.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], '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', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The InstanceId provided does not exist in our records.', ], ], ], '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' => ' ', ], 'DescribeInstanceSSL' => [ 'summary' => 'Queries whether TLS (SSL) encryption is enabled for 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' => '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '02260F96-913E-4655-9BA5-A3651CAF****', ], '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', ], 'SSLExpiredTime' => [ 'description' => 'The time when the CA certificate expires.'."\n", 'type' => 'string', 'example' => '2020-08-05T09:05:53Z', ], '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', ], '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', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidRedisVersionPattern', 'errorMessage' => 'Redis db or proxy version does not match specified pattern.', ], ], 403 => [ [ 'errorCode' => 'IncorrectCharacterType', 'errorMessage' => 'Current DB instance CharacterType does not support this operation.', ], [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support operations.', ], ], [ [ 'errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The InstanceId provided does not exist in our records.', ], ], ], '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":""}]', 'title' => 'DescribeInstanceSSL', '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.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyInstanceConfig' => [ 'summary' => 'Modifies the parameter settings of a Tair (Redis OSS-compatible) instance.', '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' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => [ 'description' => '需修改的实例参数，格式为JSON，修改后的值会覆盖原来的值。例如您只希望修改**maxmemory-policy**参数为**noeviction**，您可以传入`{"maxmemory-policy":"noeviction"}`。'."\n" .'> 关于各参数的详细说明，请参见[参数说明](~~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}', ], ], [ 'name' => 'ParamReplMode', 'in' => 'query', 'schema' => [ 'description' => '同步模式：'."\n" .'* **async**（默认）：异步'."\n" .'* **semisync**：半同步', 'type' => 'string', 'required' => false, 'example' => 'async', ], ], [ 'name' => 'ParamSemisyncReplTimeout', 'in' => 'query', 'schema' => [ 'description' => '半同步模式的降级阈值。仅半同步支持配置该参数，单位为ms，取值范围为10~60000，默认为500。'."\n" .'> * 当同步延迟超出该阈值时，同步模式会自动转为异步，当同步延迟消除后，同步模式会自动转换为半同步。'."\n" .'> * 仅Tair企业版实例支持，该功能公测中。', 'type' => 'string', 'required' => false, 'example' => '500', ], ], [ 'name' => 'ParamNoLooseSentinelEnabled', 'in' => 'query', 'schema' => [ 'description' => '哨兵兼容模式，适用于非集群实例。取值说明：'."\n" .'* **no**（默认）：未开启'."\n" .'* **yes**：开启'."\n" .'> 更多信息请参见[Sentinel兼容模式](~~178911~~)。', 'type' => 'string', 'required' => false, 'example' => 'yes', ], ], [ 'name' => 'ParamSentinelCompatEnable', 'in' => 'query', 'schema' => [ 'description' => '哨兵兼容模式，适用于集群架构代理连接模式或读写分离架构的实例，取值说明：'."\n" .'* **0**（默认）：未开启'."\n" .'* **1**：开启'."\n" .'> 更多信息请参见[Sentinel兼容模式](~~178911~~)。', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ParamNoLooseSentinelPasswordFreeAccess', 'in' => 'query', 'schema' => [ 'description' => '开启哨兵模式时，是否允许免密执行Sentinel相关命令，取值说明：'."\n" .'* **no**（默认）：关闭。'."\n" .'* **yes**：开启。开启后，可以在任意连接上免密执行Sentinel命令以及使用SENTINEL命令监听+switch-master通道。', 'type' => 'string', 'required' => false, 'example' => '****', ], ], [ 'name' => 'ParamNoLooseSentinelPasswordFreeCommands', 'in' => 'query', 'schema' => [ 'description' => '启用哨兵模式及ParamNoLooseSentinelPasswordFreeAccess参数后，可通过本参数添加额外的免密命令列表（默认为空）。'."\n" .'> * 设置后可在任意连接上无需密码执行对应命令，请谨慎操作。'."\n" .'> * 命令需使用小写字母，多个命令以英文逗号(,)分隔。', 'type' => 'string', 'required' => false, 'example' => '****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', ], [ 'errorCode' => 'ParamNotSupportedForCurrentVersion', 'errorMessage' => 'Parameter is not supported for current version.', ], ], 403 => [ [ 'errorCode' => 'InstanceType.NotSupport', 'errorMessage' => 'Current instance type does not support this operation.', ], [ 'errorCode' => 'NetworkType.NotSupport', 'errorMessage' => 'Current network type does not support this operation.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D0C0AFC-E9CD-47A4-8395-5C31BF9B****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8D0C0AFC-E9CD-47A4-8395-5C31BF9B****\\n","errorExample":""}]', 'title' => 'ModifyInstanceConfig', ], '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', ], ], ], [ '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', ], ], [ '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', ], ], [ '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****', ], ], [ '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9DA28D8E-514D-4F12-ADED-70A9C818****', ], 'Engine' => [ 'description' => 'The database engine that is run on the instance. The value **Redis** is returned for this parameter.'."\n", 'type' => 'string', 'example' => 'redis', ], 'EngineVersion' => [ 'description' => 'The major version of the instance.'."\n", 'type' => 'string', 'example' => '5.0', ], 'ParameterCount' => [ 'description' => 'The number of parameters that are supported by the instance.'."\n", 'type' => 'string', 'example' => '24', ], '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]', ], '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', ], 'ParameterValue' => [ 'description' => 'The default value of the parameter.'."\n", 'type' => 'string', 'example' => 'yes', ], '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', ], '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', ], 'ParameterDescription' => [ 'description' => 'The description of the parameter.'."\n", 'type' => 'string', 'example' => 'test description'."\n", ], ], ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', ], ], 403 => [ [ 'errorCode' => 'ParamNotSupportedForCurrentVersion', 'errorMessage' => 'Parameter is not supported for current version.', ], ], ], '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":"\\r\\n 24\\r\\n 5.0\\r\\n \\r\\n \\r\\n 1\\r\\n [yes|no]\\r\\n no\\r\\n false\\r\\n #no_loose_check-whitelist-always\\r\\n check whitelist always\\r\\n \\r\\n \\r\\n 1\\r\\n .*\\r\\n \\r\\n false\\r\\n #no_loose_disabled-commands\\r\\n You can disable some dangerous commands, for example \\"keys,flushdb,flushall\\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].\\r\\n \\r\\n \\r\\n 1\\r\\n [yes|no]\\r\\n no\\r\\n false\\r\\n #no_loose_sentinel-enabled\\r\\n Be compatible with sentinel mode.\\r\\n \\r\\n \\r\\n 1\\r\\n [yes|no]\\r\\n yes\\r\\n false\\r\\n appendonly\\r\\n 开启aof持久化模式\\r\\n \\r\\n \\r\\n 1\\r\\n \\\\d+\\\\s+\\\\d+\\\\s+\\\\d+\\r\\n 33554432 8388608 60\\r\\n false\\r\\n client-output-buffer-limit pubsub\\r\\n 发布订阅客户端写缓冲区MB\\r\\n \\r\\n \\r\\n 1\\r\\n [yes|no]\\r\\n yes\\r\\n false\\r\\n dynamic-hz\\r\\n 是否设置动态hz\\r\\n \\r\\n \\r\\n 1\\r\\n [0-999999999999999]\\r\\n 512\\r\\n false\\r\\n hash-max-ziplist-entries\\r\\n If hash fields are less than this value and hash value sizes are less than hash-max-ziplist-value, the ziplist will be used.\\r\\n \\r\\n \\r\\n 1\\r\\n [0-999999999999999]\\r\\n 64\\r\\n false\\r\\n hash-max-ziplist-value\\r\\n If hash value sizes are than less this value and hash fields are less than hash-max-ziplist-entries, the ziplist will be used.\\r\\n \\r\\n \\r\\n 1\\r\\n [1-500]\\r\\n 10\\r\\n false\\r\\n hz\\r\\n 设置Redis后台任务执行频率，比如清除过期键任务,设置范围为1到500，默认为10.越大CPU消耗越大，延迟越小，建议不要超过100\\r\\n \\r\\n \\r\\n 1\\r\\n [yes|no]\\r\\n no\\r\\n false\\r\\n lazyfree-lazy-eviction\\r\\n lazyfree switch on eviction.\\r\\n \\r\\n \\r\\n 1\\r\\n [yes|no]\\r\\n yes\\r\\n false\\r\\n lazyfree-lazy-expire\\r\\n lazyfree switch on expire.\\r\\n \\r\\n \\r\\n 1\\r\\n [yes|no]\\r\\n yes\\r\\n false\\r\\n lazyfree-lazy-server-del\\r\\n lazyfree switch on server implicit deletion.\\r\\n \\r\\n \\r\\n 1\\r\\n [0-65535]\\r\\n 0\\r\\n false\\r\\n list-compress-depth\\r\\n The number of entries on the list that are not compressed at both ends.\\r\\n \\r\\n \\r\\n 1\\r\\n [-5-99999999]\\r\\n -2\\r\\n false\\r\\n list-max-ziplist-size\\r\\n Threadhold of ziplist size on quicklist.\\r\\n \\r\\n \\r\\n 1\\r\\n [volatile-lru|allkeys-lru|volatile-random|allkeys-random|volatile-ttl|volatile-lfu|allkeys-lfu|noeviction]\\r\\n volatile-lru\\r\\n false\\r\\n maxmemory-policy\\r\\n To config how Redis will select what to remove when maxmemory is reached. There are eight behaviors that can be chose : volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction\\r\\n \\r\\n \\r\\n 1\\r\\n .*\\r\\n \\r\\n false\\r\\n notify-keyspace-events\\r\\n keyspace-event notification feature.\\r\\n \\r\\n \\r\\n 1\\r\\n [0-999999999999999]\\r\\n 512\\r\\n false\\r\\n set-max-intset-entries\\r\\n Sets have a special encoding in just one case: when a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers. The following configuration setting sets the limit in the size of the set in order to use this special memory saving encoding.\\r\\n \\r\\n \\r\\n 1\\r\\n [10000-10000000]\\r\\n 20000\\r\\n false\\r\\n slowlog-log-slower-than\\r\\n The time is expressed in microseconds, so 1000000 is equivalent to one second. The default setting for this is 20000 (20ms) and the lower bound of this setting is 10000 (10ms). \\r\\n \\r\\n \\r\\n 1\\r\\n [100-10000]\\r\\n 1024\\r\\n false\\r\\n slowlog-max-len\\r\\n The max slowlog count.\\r\\n \\r\\n \\r\\n 1\\r\\n [0-999999999999999]\\r\\n 4096\\r\\n false\\r\\n stream-node-max-bytes\\r\\n stream节点大小限制，默认4096， 取值范围：>=0, 0代表并没有限制\\r\\n \\r\\n \\r\\n 1\\r\\n [0-999999999999999]\\r\\n 100\\r\\n false\\r\\n stream-node-max-entries\\r\\n stream节点个数限制，默认100， 取值范围：>=0, 0代表并没有限制\\r\\n \\r\\n \\r\\n 1\\r\\n [0-100000]\\r\\n 0\\r\\n false\\r\\n timeout\\r\\n Close the connection after a client is idle for N seconds (0 to disable)\\r\\n \\r\\n \\r\\n 1\\r\\n [0-999999999999999]\\r\\n 128\\r\\n false\\r\\n zset-max-ziplist-entries\\r\\n Similarly to hashes and lists, sorted sets are also specially encoded in order to save a lot of space.\\r\\n \\r\\n \\r\\n 1\\r\\n [0-999999999999999]\\r\\n 64\\r\\n false\\r\\n zset-max-ziplist-value\\r\\n Similarly to hashes and lists, sorted sets are also specially encoded in order to save a lot of space.\\r\\n \\r\\n \\r\\n 9DA28D8E-514D-4F12-ADED-70A9C818F0A0\\r\\n redis\\r\\n","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' => ' ', ], 'DescribeInstanceConfig' => [ 'summary' => 'Queries the default parameter configurations 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' => '56407', '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 ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Config' => [ 'description' => 'The parameter settings of the instance. For more information, see [Parameter overview and configuration guide](~~43885~~).'."\n", '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}', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4E2C08F6-2D11-4ECD-9A4C-27EF2D3D****', ], 'ParamReplMode' => [ 'description' => 'The synchronization mode.'."\n" ."\n" .'* **semisync**'."\n" .'* **async**'."\n", 'type' => 'string', 'example' => 'async', ], 'ParamReplTimeout' => [ 'description' => 'The degradation threshold time of the semi-synchronous replication mode. This parameter is required only when semi-synchronous replication is enabled. Unit: milliseconds. Valid values: 10 to 60000.'."\n", 'type' => 'string', 'example' => '****', ], 'ParamNoLooseSentinelEnabled' => [ 'description' => 'The Sentinel-compatible mode, which is applicable to non-cluster instances. For more information about the parameter, see the relevant documentation.'."\n", 'type' => 'string', 'example' => '****', ], 'ParamSentinelCompatEnable' => [ 'description' => 'The Sentinel-compatible mode, which is applicable to cluster instances in proxy mode or read/write splitting instances. For more information about the parameter, see the relevant documentation.'."\n", 'type' => 'string', 'example' => '1', ], 'ParamNoLooseSentinelPasswordFreeAccess' => [ 'description' => 'Indicates whether Sentinel commands can be run without requiring a password when the Sentinel mode is enabled. Valid values: Valid values: yes and no. Default value: no. After you set this parameter to yes, you can run Sentinel commands in a virtual private cloud (VPC) without the need to enable the password-free access feature.'."\n", 'type' => 'string', 'example' => 'no', ], 'ParamNoLooseSentinelPasswordFreeCommands' => [ 'description' => 'After you enable the Sentinel mode and set the ParamNoLooseSentinelPasswordFreeAccess parameter to yes, you can use this parameter to specify an additional list of commands that can be run without requiring a password. By default, this parameter is empty. After you configure this parameter, you can run the specified commands without a password on any connection. Proceed with caution. The commands must be written in lowercase letters. Multiple commands are separated by commas (,).'."\n", 'type' => 'string', 'example' => '****', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\n 4E2C08F6-2D11-4ECD-9A4C-27EF2D3D****\\n {\\"#no_loose_statistics-cmds\\":\\"SET,GET\\",\\"EvictionPolicy\\":\\"volatile-lru\\",\\"hash-max-ziplist-entries\\":512,\\"slowlog-log-slower-than\\":\\"1000\\",\\"notify-keyspace-events\\":\\"$\\",\\"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,\\"#no_loose_disabled-commands\\":\\"flushall\\"}\\n","errorExample":""}]', 'title' => 'DescribeInstanceConfig', 'description' => 'This operation is available only for instances that use cloud disks.'."\n" ."\n" .'> You can call the [DescribeParameters](~~473847~~) operation to query the parameter settings of instances that use local disks.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeParameters' => [ 'summary' => 'Queries the configuration parameters and running parameters of a Tair (Redis OSS-compatible) instance.', '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 of the instance. You can call the [DescribeRegions](~~473763~~) operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9C1338BE-8DE8-4890-A900-E1BC06BF****', ], 'Engine' => [ 'description' => 'The database engine that the instance runs.'."\n", 'type' => 'string', 'example' => 'redis', ], 'EngineVersion' => [ 'description' => 'The database engine version of the instance.'."\n", 'type' => 'string', 'example' => '4.0', ], 'ConfigParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Parameter' => [ 'description' => 'The configuration parameters that have not taken effect.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the array object.'."\n", 'type' => 'object', 'properties' => [ 'CheckingCode' => [ 'description' => 'The check code that indicates the valid values of the parameter.'."\n", 'type' => 'string', 'example' => '[0|1]', ], 'ParameterName' => [ 'description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'script_check_enable', ], 'ParameterValue' => [ 'description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => '1', ], 'ForceRestart' => [ 'description' => 'Indicates whether the instance must be restarted for the modifications to take effect. Valid values:'."\n" ."\n" .'* **True**: The instance must be restarted for the modifications to take effect.'."\n" .'* **False**: The instance does not need to be restarted for the modifications to take effect. Modifications immediately take effect.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'ParameterDescription' => [ 'description' => 'The description of the parameter.'."\n", 'type' => 'string', 'example' => 'Check all keys passed in the KEYS array map to the same slot.', ], 'ModifiableStatus' => [ 'description' => 'Indicates whether the parameter can be reset. Valid values:'."\n" ."\n" .'* **False**: The parameter cannot be reset.'."\n" .'* **True**: The parameter can be reset.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], 'RunningParameters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Parameter' => [ 'description' => 'The running parameters.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the array object.'."\n", 'type' => 'object', 'properties' => [ 'CheckingCode' => [ 'description' => 'The check code that indicates the valid values of the parameter.'."\n", 'type' => 'string', 'example' => '[0|1]', ], 'ParameterName' => [ 'description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => '#no_loose_disabled-commands', ], 'ParameterValue' => [ 'description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => 'keys,flushall,flushdb', ], 'ForceRestart' => [ 'description' => 'Indicates whether the instance must be restarted for the modifications to take effect. Valid values:'."\n" ."\n" .'* **True**: The instance must be restarted for the modifications to take effect.'."\n" .'* **False**: The instance does not need to be restarted for the modifications to take effect. Modifications immediately take effect.'."\n", 'type' => 'string', 'example' => 'true', ], 'ParameterDescription' => [ 'description' => 'The description of the parameter.'."\n", '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].', ], 'ModifiableStatus' => [ 'description' => 'Indicates whether the parameter can be reset. Valid values:'."\n" ."\n" .'* **False**: The parameter cannot be reset.'."\n" .'* **True**: The parameter can be reset.'."\n", 'type' => 'string', 'example' => 'true', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'IncorrectDBInstanceType', 'errorMessage' => 'Current DB instance type does not support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceClass.NotFound', 'errorMessage' => 'Specified DB instance class is not found.', ], ], ], 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"\\r\\n\\t\\r\\n\\t9C1338BE-8DE8-4890-A900-E1BC06BF****\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tcheck whitelist always\\r\\n\\t\\t\\tno\\r\\n\\t\\t\\t[yes|no]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\t#no_loose_check-whitelist-always\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tYou can disable some dangerous commands, for example "keys,flushdb,flushall", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].\\r\\n\\t\\t\\tkeys,flushall,flushdb\\r\\n\\t\\t\\t.*\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\t#no_loose_disabled-commands\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t开启关闭SSL\\r\\n\\t\\t\\tyes\\r\\n\\t\\t\\t[yes|no]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\t#no_loose_ssl-enabled\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tBe compatible with cluster mode.\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t[0|1]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tcluster_compat_enable\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tCheck all keys passed in the KEYS array map to the same slot.\\r\\n\\t\\t\\t1\\r\\n\\t\\t\\t[0|1]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tscript_check_enable\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tIf hash fields are less than this value and hash value sizes are less than hash-max-ziplist-value, the ziplist will be used.\\r\\n\\t\\t\\t512\\r\\n\\t\\t\\t[0-999999999999999]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\thash-max-ziplist-entries\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tIf hash value sizes are than less this value and hash fields are less than hash-max-ziplist-entries, the ziplist will be used.\\r\\n\\t\\t\\t64\\r\\n\\t\\t\\t[0-999999999999999]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\thash-max-ziplist-value\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tlazyfree switch on eviction.\\r\\n\\t\\t\\tyes\\r\\n\\t\\t\\t[yes|no]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tlazyfree-lazy-eviction\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tlazyfree switch on expire.\\r\\n\\t\\t\\tyes\\r\\n\\t\\t\\t[yes|no]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tlazyfree-lazy-expire\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tlazyfree switch on server implicit deletion.\\r\\n\\t\\t\\tyes\\r\\n\\t\\t\\t[yes|no]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tlazyfree-lazy-server-del\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tThe number of entries on the list that are not compressed at both ends.\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t[0-65535]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tlist-compress-depth\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tThreadhold of ziplist size on quicklist.\\r\\n\\t\\t\\t-2\\r\\n\\t\\t\\t[-5-99999999]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tlist-max-ziplist-size\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tTo config how Redis will select what to remove when maxmemory is reached. There are eight behaviors that can be chose : volatile-lru,allkeys-lru,volatile-lfu,allkeys-lfu,volatile-random,allkeys-random,volatile-ttl,noeviction\\r\\n\\t\\t\\tvolatile-lfu\\r\\n\\t\\t\\t[volatile-lru|allkeys-lru|volatile-random|allkeys-random|volatile-ttl|volatile-lfu|allkeys-lfu|noeviction]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tmaxmemory-policy\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tSets have a special encoding in just one case: when a set is composed\\r\\n\\t\\t\\t\\tof just strings that happen to be integers in radix 10 in the range\\r\\n\\t\\t\\t\\tof 64 bit signed integers.\\r\\n\\t\\t\\t\\tThe following configuration setting sets the limit in the size of the\\r\\n\\t\\t\\tset in order to use this special memory saving encoding.\\r\\n\\t\\t\\t512\\r\\n\\t\\t\\t[0-999999999999999]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tset-max-intset-entries\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tThe time is expressed in microseconds, so 1000000 is equivalent\\r\\n\\t\\t\\t\\tto one second. Note that a negative number disables the slow log,\\r\\n\\t\\t\\twhile a value of zero forces the logging of every command.\\r\\n\\t\\t\\t10000\\r\\n\\t\\t\\t[0-10000000]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tslowlog-log-slower-than\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tThe max slowlog count.\\r\\n\\t\\t\\t1024\\r\\n\\t\\t\\t[100-10000]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tslowlog-max-len\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tSimilarly to hashes and lists, sorted sets are also specially encoded in\\r\\n\\t\\t\\torder to save a lot of space.\\r\\n\\t\\t\\t128\\r\\n\\t\\t\\t[0-999999999999999]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tzset-max-ziplist-entries\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tSimilarly to hashes and lists, sorted sets are also specially encoded in\\r\\n\\t\\t\\torder to save a lot of space.\\r\\n\\t\\t\\t64\\r\\n\\t\\t\\t[0-999999999999999]\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tzset-max-ziplist-value\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t4.0\\r\\n\\tredis\\r\\n","errorExample":"{\\n \\"ConfigParameters\\":{\\n \\"Parameter\\":[\\n\\n ]\\n },\\n \\"RequestId\\":\\"90A7936F-B9A3-4226-9B47-CF1D0EF81604\\",\\n \\"RunningParameters\\":{\\n \\"Parameter\\":[\\n {\\n \\"ParameterDescription\\":\\"Redis可支持的最大key，value长度\\",\\n \\"ParameterValue\\":\\"4194304\\",\\n \\"CheckingCode\\":\\"[0-9]+\\",\\n \\"ForceRestart\\":\\"false\\",\\n \\"ModifiableStatus\\":\\"true\\",\\n \\"ParameterName\\":\\"#no_loose_max-memcached-allow-request-length\\"\\n },\\n {\\n \\"ParameterValue\\":\\"512\\",\\n \\"CheckingCode\\":\\"[0-999999999999999]\\",\\n \\"ForceRestart\\":\\"false\\",\\n \\"ModifiableStatus\\":\\"true\\",\\n \\"ParameterName\\":\\"set-max-intset-entries\\"\\n },\\n {\\n \\"ParameterValue\\":\\"64\\",\\n \\"CheckingCode\\":\\"[0-999999999999999]\\",\\n \\"ForceRestart\\":\\"false\\",\\n \\"ModifiableStatus\\":\\"true\\",\\n \\"ParameterName\\":\\"zset-max-ziplist-value\\"\\n }\\n ]\\n },\\n \\"EngineVersion\\":\\"2.8\\",\\n \\"Engine\\":\\"redis\\"\\n}"}]', 'title' => 'DescribeParameters', 'description' => 'This operation is applicable only to classic instances.'."\n" ."\n" .'> If the instance is deployed in cloud-native mode, you can use the [DescribeInstanceConfig](~~473846~~) operation to query the configuration and operational parameters of the instance.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'ParameterName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'script_check_enable', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '963C20F0-7CE1-4591-AAF3-6F3CD1CE****', ], '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', ], 'ParameterName' => [ 'description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'script_check_enable', ], 'NewParameterValue' => [ 'description' => 'The parameter value after modification.'."\n", 'type' => 'string', 'example' => '0', ], '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', ], ], ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The Specified parameter StartTime is not valid.', ], [ 'errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The Specified parameter EndTime is not valid.', ], ], ], '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', ], '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', ], ], [ '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', ], ], ], [ '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****', ], ], [ '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****', ], 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', 'maxItems' => 51, ], ], [ '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', ], 'Value' => [ 'description' => 'The values of the tags associated with the instances you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'demovalue', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], ], '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****', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '47A514A1-4B77-4E30-B4C5-2A880650****', ], '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', ], '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', ], 'ResourceId' => [ 'description' => 'The resource ID, which is also the ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'TagKey' => [ 'description' => 'The keys of the tags.'."\n", 'type' => 'string', 'example' => 'demokey', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Key or TagKey.n is not valid.', ], [ 'errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Value is not valid.', ], [ 'errorCode' => 'InvalidParameter.ResourceId', 'errorMessage' => 'The specified parameter ResourceId.n is not valid.', ], [ 'errorCode' => 'MissParameter.TagOrResourceId', 'errorMessage' => 'The parameter Tag.n or ResourceId.n is needed.', ], [ 'errorCode' => 'InvalidParameter.Scope', 'errorMessage' => 'The specified parameter Scope is not valid.', ], [ 'errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter number is exceed.', ], [ 'errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter number is exceed.', ], [ 'errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The specified parameter Tag.n.Key is duplicated.', ], [ 'errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The specified parameter ResourceType is not valid.', ], ], 404 => [ [ 'errorCode' => 'InvalidDbInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', ], ], ], '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' => ' ', ], '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', ], ], [ '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', ], ], ], [ '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****', ], 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'maxItems' => 51, ], ], [ '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', ], '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', ], ], 'required' => false, ], 'required' => true, 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4BD4E308-A3D8-4CD1-98B3-0ADAEE38****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter number is exceed, Valid is 20.', ], [ 'errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Key or TagKey.n is not valid.', ], [ 'errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Value is not valid.', ], [ 'errorCode' => 'InvalidParameter.ResourceId', 'errorMessage' => 'The specified parameter ResourceId.n is not valid.', ], [ 'errorCode' => 'MissParameter.TagOrResourceId', 'errorMessage' => 'The parameter Tag.n or ResourceId.n is needed.', ], [ 'errorCode' => 'InvalidParameter.Scope', 'errorMessage' => 'The specified parameter Scope is not valid.', ], [ 'errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter number is exceed.', ], [ 'errorCode' => 'NumberExceed.CustomTags', 'errorMessage' => 'The Custom Tags parameter number is exceed. Valid is 20.', ], [ 'errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The specified parameter Tag.n.Key is duplicated.', ], [ 'errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The specified parameter ResourceType is not valid.', ], [ 'errorCode' => 'OperationDenied.QuotaExceed', 'errorMessage' => 'The Tags parameter number is exceed. Valid is 20.', ], ], 404 => [ [ 'errorCode' => 'InvalidDbInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', ], ], ], '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' => ' ', ], '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', ], ], [ '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', ], ], ], [ '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', ], ], [ '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****', ], 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', 'maxItems' => 51, ], ], [ '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', ], 'required' => false, 'example' => 'demokey', 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '601B6F25-21E7-4484-99D5-3EF2625C****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Key or TagKey.n is not valid.', ], [ 'errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The specified parameter Tag.n.Value is not valid.', ], [ 'errorCode' => 'InvalidParameter.ResourceId', 'errorMessage' => 'The specified parameter ResourceId.n is not valid.', ], [ 'errorCode' => 'MissParameter.TagOrResourceId', 'errorMessage' => 'The parameter Tag.n or ResourceId.n is needed.', ], [ 'errorCode' => 'InvalidParameter.Scope', 'errorMessage' => 'The specified parameter Scope is not valid.', ], [ 'errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter number is exceed.', ], [ 'errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter number is exceed.', ], [ 'errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The specified parameter Tag.n.Key is duplicated.', ], [ 'errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The specified parameter ResourceType is not valid.', ], ], 404 => [ [ 'errorCode' => 'InvalidDbInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', ], ], ], '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' => ' ', ], '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'BBC1E3D6-7C88-4DF5-9A3D-0DB1E6D9****', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support this operation.', ], ], ], '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", 'extraInfo' => ' ', ], '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' => '-bp1zxszhcgatnx****', ], ], [ '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', ], ], [ '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', ], ], ], [ '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', ], ], ], [ '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', ], ], [ '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' => '-bp1zxszhcgatnx****-db-0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The maximum number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A057C066-C3F5-4CC9-9FE4-A8D8B0DC****', ], 'PageRecordCount' => [ 'description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'TotalRecordCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '160', ], '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}]', ], ], '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' => '[]', ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support this operation.', ], ], ], '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~~)', ], '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****', ], ], [ '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', ], ], [ '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', ], ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => '1041xxxx', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '743D0A03-52DE-4E6F-8D09-EC1414CF****', ], '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', ], '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', ], 'StartTime' => [ 'description' => 'The start time of the offline key analytics task.'."\n", 'type' => 'string', 'example' => '2019-08-01T19:08:49Z', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'string', 'example' => '156465****', ], 'NodeId' => [ 'description' => 'The ID of the child node in the cluster instance.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****-db-0', ], ], ], ], ], ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'IncorrectEngineVersion', 'errorMessage' => 'Current engine version does not support this operation.', ], ], ], '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~~)', ], '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****', ], ], [ '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', ], ], [ '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', ], ], [ '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********', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter InstanceName is not valid.', ], [ 'errorCode' => 'TaskExists', 'errorMessage' => 'Specified task have existed.', ], ], ], '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' => ' ', ], '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****', ], ], ], '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', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The InstanceId provided does not exist in our records.', ], ], ], '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' => ' ', ], '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '10E2160B-959C-5C3E-BFE6-86EC5925****', ], '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********', ], ], ], ], ], ], ], ], '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":""}]', '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' => ' ', ], '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****', ], ], [ '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********', ], ], ], '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', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9A931CE5-C926-5E09-B0EC-6299C4A6****', ], 'Description' => [ 'description' => 'The description of the custom key. By default, an empty string is returned.'."\n", 'type' => 'string', 'example' => 'testkey', ], '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', ], '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', ], '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', ], 'KeyUsage' => [ 'description' => 'The purpose of the custom key. A value of `ENCRYPT/DECRYPT` indicates encryption and decryption.'."\n", 'type' => 'string', 'example' => 'ENCRYPT/DECRYPT', ], 'EncryptionKey' => [ 'description' => 'The ID of the custom key.'."\n", 'type' => 'string', 'example' => 'ad463061-992d-4195-8a94-ed63********', ], 'Creator' => [ 'description' => 'The ID of the Alibaba Cloud account that is used to create the custom key.'."\n", 'type' => 'string', 'example' => '17649847********', ], 'EncryptionName' => [ 'description' => 'The encryption algorithm.'."\n", 'type' => 'string', 'example' => 'AES-CTR-256', ], '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', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InstanceType.NotSupport', 'errorMessage' => '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' => ' ', ], '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****', ], ], [ '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', ], ], ], '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', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****', ], ], ], ], ], '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' => ' ', ], '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TaskCount' => [ 'description' => 'The number of pending O\\&M tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], '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', ], 'RequestId' => [ 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '2D9F3768-EDA9-4811-943E-42C8006E****', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], ], ], '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', ], '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', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Valid values: 10 to 100. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The 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', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => 'Set the value to Instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Instance', ], ], [ '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', ], ], [ '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", ], ], [ '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", ], ], [ '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', ], ], [ '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', ], ], [ '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-03-02T11:31:03Z', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], 'PageSize' => [ 'description' => 'The maximum number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => 'The total number of tasks that meet these constraints without taking pagination into account.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], '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', ], 'TaskId' => [ 'description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 't-83br18hloy3faf****', ], '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', ], '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', ], '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', ], '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', ], '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', ], 'Progress' => [ 'description' => 'The task progress. Valid values: 0 to 100.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '79.0', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-shanghai', ], 'InstanceType' => [ 'description' => 'The instance type. The return value is Instance.'."\n", 'type' => 'string', 'example' => 'Instance', ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'dba-tair-test-qcloud', ], 'DbType' => [ 'description' => 'The database type. The return value is redis.'."\n", 'type' => 'string', 'example' => 'redis', ], 'Product' => [ 'description' => 'The product. The return value is kvstore.'."\n", 'type' => 'string', 'example' => 'kvstore', ], 'TaskDetail' => [ 'description' => 'The task details. The details vary based on the task type.'."\n", 'type' => 'string', 'example' => '{\\"callerUid\\":\\"test\\"}', ], 'ReasonCode' => [ 'description' => 'The reason why the current task was initiated.'."\n", 'type' => 'string', 'example' => 'UpgradeMinorVersion', ], '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\\"}]}'."\n", ], 'Uid' => [ 'description' => 'The ID of the user to which the resources belong.'."\n", 'type' => 'string', 'example' => '141345906006****', ], '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****', ], 'CallerUid' => [ 'description' => 'The request source. Valid values:'."\n" ."\n" .'* **System**'."\n" .'* **User**'."\n", 'type' => 'string', 'example' => 'User', ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', ], [ 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', ], ], ], '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', ], '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', ], ], [ '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', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ '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', ], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'all', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], '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****', ], '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', ], 'TotalCount' => [ 'description' => 'The total number of tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'Param.Invalid', 'errorMessage' => 'Param invalid', ], [ 'errorCode' => 'Param.Invalid.TimeEndBeforeStart', 'errorMessage' => 'Param invalid. End time before start time', ], ], ], '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', ], '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', ], ], [ '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', ], ], ], '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', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'TaskModifyError', 'errorMessage' => 'Part of the tasks cannot be modified.', ], [ 'errorCode' => 'SwitchTimeAfterDeadline', 'errorMessage' => 'The switch time should be earlier than deadline.', ], [ 'errorCode' => 'StartTimeBeforeNow', 'errorMessage' => 'The start time should not be earlier than the current time.', ], ], 403 => [ [ 'errorCode' => 'IncorrectTaskStatus', 'errorMessage' => 'Certain task\'s status does not support this operation.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Ids\\": \\"11111,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' => ' ', ], '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', ], ], [ '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' => 'all', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => [ 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2E1FF0CC-F42A-4B6F-A1F4-A17B1451****', ], 'PageSize' => [ 'description' => 'The maximum number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'TotalRecordCount' => [ 'description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], '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', ], '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-07-19 23:59:59', ], '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', ], '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', ], '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' => '2018-07-19 10:00:00', ], '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-07-19 14:00:00', ], 'InsName' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp1lgal1sdvxrz****', ], 'DbType' => [ 'description' => 'The database type of the instance. The return value is **Redis**.'."\n", 'type' => 'string', 'example' => 'redis', ], 'Region' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hanghzou', ], '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-07-15 23:59:59', ], 'Id' => [ 'description' => 'The ID of the O&M task.', 'type' => 'integer', 'format' => 'int32', 'example' => '114111', ], '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-07-19 14:00:00', ], ], 'description' => '', ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], ], ], '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' => ' ', ], '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', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '794120D1-E0CF-4713-BAE4-EBAEA04506AF', ], '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', ], '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', ], '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", ], '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', ], '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", ], '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', ], '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", ], ], ], ], 'description' => '', ], ], ], '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', ], 'ModifyActiveOperationMaintainConfig' => [ 'summary' => 'ModifyActiveOperationMaintainConf', '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 unit of the billing cycle. Valid values:'."\n" ."\n" .'* Month'."\n" .'* Week'."\n", 'type' => 'string', 'required' => false, 'example' => 'Week', ], ], [ 'name' => 'CycleTime', 'in' => 'query', 'schema' => [ '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', 'required' => false, 'example' => '1,2,3,4,5', ], ], [ 'name' => 'MaintainStartTime', 'in' => 'query', 'schema' => [ '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', 'required' => false, 'example' => '16:00:00Z', ], ], [ 'name' => 'MaintainEndTime', 'in' => 'query', 'schema' => [ 'description' => 'The end time of the O\\&M window. The time follows the ISO 8601 standard in the HH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '20:00:00Z', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the configurations take effect. Valid values:'."\n" ."\n" .'* 1: The configurations take effect.'."\n" .'* 2: The configurations do not take effect.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"561AFBF1-BE20-44DB-9BD1-6988B53E****\\"\\n}","type":"json"}]', 'title' => 'ModifyActiveOperationMaintainConfig', ], '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****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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, ], ], [ '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' => '111.175.56.206,47.253.88.168,111.181.0.162', ], ], ], '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****', ], '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-sdgwqyp4f5j1x3qk7yvm', ], 'GlobalIgName' => [ 'description' => 'The name of the IP whitelist template.'."\n", 'type' => 'string', 'example' => 'white_list_test_sg', ], 'GIpList' => [ 'description' => 'The IP addresses in the IP whitelist template.'."\n", 'type' => 'string', 'example' => '192.168.0.1', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', ], [ 'errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', ], [ 'errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', ], ], 404 => [ [ 'errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', ], ], ], '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', ], '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', ], ], [ '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, ], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the IP whitelist template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'g-kd2iop4aur9qwxnvh***', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', ], ], ], '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****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B17D708-1D6D-49F3-B6D7-478371DD****\\"\\n}","type":"json"}]', 'title' => 'ModifyGlobalSecurityIPGroupName', ], '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', ], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-t4n885e834f6****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-t4n885e834f6****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', ], '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****', ], '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', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'GlobalIgName' => [ 'description' => 'The name of the IP whitelist template.'."\n", 'type' => 'string', 'example' => 'test_123', ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], ], ], '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', ], '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', ], ], [ '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', ], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the IP whitelist template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'g-kd2iop4aur9qwxnvh***', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4e******', ], ], ], '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****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], ], ], '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", ], '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****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ '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, ], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the IP whitelist template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'g-zsldxfiwjmti0kcm****', ], ], [ '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', ], ], ], '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****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', ], [ 'errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', ], [ 'errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"686BB8A6-BBA5-47E5-8A75-D2ADE433****\\"\\n}","type":"json"}]', 'title' => 'ModifyGlobalSecurityIPGroup', ], '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', ], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-t4n885e834f6****', ], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The ID of the IP whitelist template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'g-zsldxfiwjmti0kcm****', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', ], ], ], '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****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'The specified parameters are invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E83311F-0EE4-4922-A3BF-730B312B****\\"\\n}","type":"json"}]', 'title' => 'ModifyGlobalSecurityIPGroupRelation', ], '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 resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'GlobalSecurityGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the IP whitelist template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'g-zsldxfiwjmti0kcm****', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'type' => 'string', 'default' => 'redis', 'enum' => [ 'redis', 'memcache', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2FF6158E-3394-4A90-B634-79C49184****', ], 'GlobalSecurityIPGroup' => [ 'description' => 'The information about the 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****', ], 'GlobalIgName' => [ 'description' => 'The name of the IP whitelist template.'."\n", 'type' => 'string', 'example' => 'test_123', ], 'GIpList' => [ 'description' => 'The IP address in the IP whitelist template.'."\n" ."\n" .'> Multiple IP addresses are separated by commas (,).'."\n", 'type' => 'string', 'example' => '125.38.177.62,221.197.232.185', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'DBInstances' => [ 'description' => 'The IDs of the instances that are associated with the IP whitelist template.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-****', ], ], ], 'description' => '1'."\n", ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'RequiredParam.NotFound', 'errorMessage' => 'Required input param is not found.', ], [ 'errorCode' => 'InvalidAction', 'errorMessage' => 'Specified action is not valid.', ], ], 404 => [ [ 'errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', ], ], ], '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', ], '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', ], ], [ '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****', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => [ 'description' => 'The information about parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"hz": "50"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****', ], 'InstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'TaskId' => [ 'description' => 'The ID of the task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '578678678', ], ], ], ], ], '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', ], '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' => 'rpg-sys-00*****'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', ], 'ParamGroupId' => [ 'description' => 'The parameter template ID, which is globally unique.'."\n", 'type' => 'string', 'example' => 'sys-001*****'."\n", ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BE6E619-A657-42E3-AD2D-18F8428A****\\",\\n \\"ParamGroupId\\": \\"rpg-sys-00*****\\"\\n}","type":"json"}]', 'title' => 'DeleteParameterGroup', ], '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', ], ], [ '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', ], ], [ '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', ], ], ], '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' => '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', ], 'DbVersion' => [ 'description' => 'The engine version.'."\n", 'type' => 'string', 'example' => '5', ], 'Category' => [ 'description' => 'The service category.'."\n", 'type' => 'string', 'example' => 'standard', ], 'ParamName' => [ 'description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'rt_threshold_ms', ], ], ], ], ], ], ], ], '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', ], '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', ], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the parameter template.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rpg-sys-00*****', ], ], ], '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' => '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', ], 'Modified' => [ 'description' => 'The time when the parameter template was last modified.'."\n", 'type' => 'string', 'example' => '2023-04-18 16:32:45', ], 'ParameterGroupName' => [ 'description' => 'The name of the parameter template.'."\n", 'type' => 'string', 'example' => 'testGroupName', ], 'ParameterGroupDesc' => [ 'description' => 'The description of the parameter template.'."\n", 'type' => 'string', 'example' => 'test', ], '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', ], 'ParamGroupId' => [ 'description' => 'The parameter template ID, which is globally unique.'."\n", 'type' => 'string', 'example' => 'sys-001*****', ], 'Created' => [ 'description' => 'The time when the parameter template was created.'."\n", 'type' => 'string', 'example' => '2023-04-18 16:32:45', ], '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', ], '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', ], 'ParamValue' => [ 'description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => '1000', ], ], ], ], ], ], ], ], ], ], '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', ], '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', ], ], [ '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', ], ], [ 'name' => 'ParameterGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The parameter template ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sys-001****', ], ], [ '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', ], ], [ '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', ], ], [ '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"}', ], ], ], '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****', ], 'ParamGroupId' => [ 'description' => 'The parameter template ID.'."\n", 'type' => 'string', 'example' => 'testGroupName', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD425AD3-CC7B-4EE2-A5CB-2F61BA73****\\",\\n \\"ParamGroupId\\": \\"testGroupName\\"\\n}","type":"json"}]', 'title' => 'ModifyParameterGroup', ], 'DescribeParameterGroups' => [ 'summary' => 'Queries a 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 of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DbType', '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' => false, 'example' => 'redis', ], ], ], '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****', ], 'ParameterGroups' => [ 'description' => 'The list of parameter templates.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EngineVersion' => [ 'description' => 'The compatible engine version.'."\n", 'type' => 'string', 'example' => '5', ], 'Modified' => [ 'description' => 'The time when the parameter template was last modified.'."\n", 'type' => 'string', 'example' => '2023-04-18 16:32:45', ], 'ParameterGroupName' => [ 'description' => 'The name of the parameter template.'."\n", 'type' => 'string', 'example' => 'testGroupName', ], 'ParameterGroupDesc' => [ 'description' => 'The description of the parameter template.'."\n", 'type' => 'string', 'example' => 'test', ], 'Engine' => [ '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', 'example' => 'redis', ], 'ParamGroupId' => [ 'description' => 'The parameter template ID.'."\n", 'type' => 'string', 'example' => 'test01', ], 'Created' => [ 'description' => 'The time when the parameter template was created.'."\n", 'type' => 'string', 'example' => '2023-04-18 16:32:45'."\n", ], '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' => '0', ], ], 'description' => '', ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], '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"}]', 'title' => 'DescribeParameterGroups', ], '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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"}', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', '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****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameters.Format', 'errorMessage' => 'Specified parameters is not valid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"62DA5BE5-F9C9-527C-ACCB-4D783C297A3A\\",\\n \\"ParamGroupId\\": \\"g-51ii2ienn0dg0xi8****\\"\\n}","type":"json"}]', 'title' => 'CreateParameterGroup', ], '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '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', ], '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', ], 'CheckingCode' => [ 'description' => 'The regular expression used to validate input.'."\n", 'type' => 'string', 'example' => '"\\\\d+\\\\s+\\\\d+\\\\s+\\\\d+"', ], 'ParameterValue' => [ 'description' => 'The default value of the parameter.'."\n", 'type' => 'string', 'example' => '10', ], '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', ], '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', ], 'ParameterName' => [ 'description' => 'The parameter name.'."\n", 'type' => 'string', 'example' => 'appendonly', ], 'Unit' => [ 'description' => 'The unit of the parameter value. Valid values: INT (ordinary integer), STRING (fixed string), and B (byte).'."\n", 'type' => 'string', 'example' => 'STRING', ], 'ParameterDescription' => [ 'description' => 'The description of the parameter.'."\n", 'type' => 'string', 'example' => 'Open AOF persistence mode', ], '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', ], ], ], ], ], ], ], ], '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', ], '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', ], ], [ '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' => 'all', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'DbType', 'in' => 'query', 'schema' => [ 'description' => 'The database type. Valid values: **redis**', 'type' => 'string', 'required' => false, 'example' => 'redis', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2D9F3768-EDA9-4811-943E-42C8006E****', ], 'PageSize' => [ 'description' => 'The number of entries returned per page. Default 25.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', ], 'TotalRecordCount' => [ 'description' => 'The number of O\\&M events returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], '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', ], 'ChangeLevelEn' => [ 'description' => 'The level of the task in English.'."\n", 'type' => 'string', 'example' => 'System maintenance'."\n", ], 'TaskType' => [ 'description' => 'The type of the O\\&M event.'."\n", 'type' => 'string', 'example' => 'rds_apsaradb_transfer', ], 'InsName' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1lgal1sdvxrz****', ], 'Region' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-hanghzou', ], 'ImpactZh' => [ 'description' => 'The impact of the task in Chinese.'."\n", 'type' => 'string', 'example' => '实例闪断'."\n", ], '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", ], '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", ], 'ChangeLevelZh' => [ 'description' => 'The level of the task in Chinese.'."\n", 'type' => 'string', 'example' => '系统运维'."\n", ], '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', ], '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", ], 'TaskTypeZh' => [ 'description' => 'The reason for the task in Chinese.'."\n", 'type' => 'string', 'example' => '小版本升级'."\n", ], 'CurrentAVZ' => [ 'description' => 'The current zone.'."\n", 'type' => 'string', 'example' => 'cn-beijing-h'."\n", ], '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', ], 'DbVersion' => [ 'description' => 'The version of the database engine.'."\n", 'type' => 'string', 'example' => '5.0', ], 'ImpactEn' => [ 'description' => 'The impact of the task in English.'."\n", 'type' => 'string', 'example' => 'Transient instance disconnection', ], 'InsComment' => [ 'description' => 'The alias and description of the instance.', 'type' => 'string', 'example' => 'test', ], '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", ], '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", ], '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', ], 'DbType' => [ 'description' => 'The database type of the instance. The return value is **Redis**.'."\n", 'type' => 'string', 'example' => 'redis', ], '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', ], 'TaskTypeEn' => [ 'description' => 'The cause of the O\\&M event.'."\n", 'type' => 'string', 'example' => 'Minor version update', ], 'ResultInfo' => [ 'description' => 'The information about the execution result.'."\n", 'type' => 'string', 'example' => 'userCancel', ], 'Id' => [ 'description' => 'The ID of the O\\&M event.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11111', ], '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", ], ], 'TaskParams' => [ 'description' => 'The O\\&M event parameters.'."\n", 'type' => 'string', 'example' => '{'."\n" .' "Action": "UpgradeDBInstance"'."\n" .'}', ], 'Impact' => [ 'description' => 'The impact of the task.'."\n", 'type' => 'string', 'example' => 'TransientDisconnection', ], ], ], ], ], 'description' => '', ], ], ], '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', ], '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', ], ], [ '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", ], ], [ '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", ], ], ], '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', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E278D833-BB4B-50BF-8646-7BC1BAB2373B', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"11111,22222\\",\\n \\"RequestId\\": \\"E278D833-BB4B-50BF-8646-7BC1BAB2373B\\"\\n}","type":"json"}]', 'title' => 'ModifyActiveOperationTasks', ], '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', ], ], ], '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', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F16A51B0-436E-5B84-8326-A18AA150D1C4', ], ], 'description' => '', ], ], ], '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", ], 'ModifyEventInfo' => [ 'summary' => '事件中心修改事件信息', '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 region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => [ 'title' => '事件ID，多个英文逗号分隔，最多支持20个', 'description' => 'The event IDs. Separate multiple event IDs with commas (,). You can specify up to 20 event IDs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5422964'."\n", ], ], [ 'name' => 'EventAction', 'in' => 'query', 'schema' => [ 'title' => '事件处理动作，目前支持archive和undo', 'description' => 'The event handling action. Valid values:'."\n" ."\n" .'* **archive**'."\n" .'* **undo**'."\n", 'type' => 'string', 'required' => false, 'example' => 'archive', ], ], [ 'name' => 'ActionParams', 'in' => 'query', 'schema' => [ 'title' => '动作参数，JSON String', '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' => '{"recoverTime":"2023-04-17T14:02:35Z","recoverMode":"timePoint"}'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6C9E114C-217C-4118-83C0-B4070222****', ], 'ErrorEventId' => [ 'description' => 'The error ID.'."\n", 'type' => 'string', 'example' => '12343', ], 'SuccessCount' => [ 'description' => 'The number of successful records.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ErrorCode' => [ 'description' => 'The error code that is returned if the request failed.'."\n", 'type' => 'string', 'example' => 'mst.errorcode.success.errormessage', ], 'SuccessEventId' => [ 'description' => 'The ID of the successful event.'."\n", 'type' => 'string', 'example' => '234221', ], ], ], ], ], '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"}]', 'title' => 'ModifyEventInfo', ], '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ '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", ], ], [ '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', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'EventId', 'in' => 'query', 'schema' => [ 'description' => 'The event ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '5345398', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => 'The task IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => '578678678', ], ], [ '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', ], ], [ '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', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfnuslkubs****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '27B911BF-4E17-5F8A-A932-79DF2D3F****', ], 'PageSize' => [ 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => 'The total number of returned events.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '430', ], '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', ], 'Region' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hanghzou', ], 'Source' => [ 'description' => 'The source of the event.'."\n", 'type' => 'string', 'example' => 'loanBill', ], 'Specversion' => [ 'description' => 'The database engine version.'."\n", 'type' => 'string', 'example' => '8.0', ], 'Subject' => [ 'description' => 'The name of the pending event.'."\n", 'type' => 'string', 'example' => 'Qitian', ], 'Time' => [ 'description' => 'The amount of time that has elapsed from the start time of the query. Unit: seconds.'."\n", 'type' => 'string', 'example' => '1734919325126', ], 'Type' => [ 'description' => 'The type of the event.'."\n", 'type' => 'string', 'example' => 'host', ], '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', ], 'EventId' => [ 'description' => 'The ID of the event.'."\n", 'type' => 'string', 'example' => '669036', ], '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', ], 'DbType' => [ 'description' => 'The database type.'."\n", 'type' => 'string', 'example' => 'redis', ], 'DetailImpact' => [ 'description' => 'The pagination parameter.'."\n", 'type' => 'string', 'example' => '1', ], 'DetailReason' => [ 'description' => 'The details of the instance operation.'."\n", 'type' => 'string', 'example' => 'xxxx', ], 'EndTime' => [ 'description' => 'The time when the alert was closed.'."\n", 'type' => 'string', 'example' => '2023-03-06T11:46:01Z'."\n", ], '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', ], 'EventCode' => [ 'description' => 'The event code.'."\n", 'type' => 'string', 'example' => 'ENT000014'."\n", ], 'EventDetail' => [ 'description' => 'The event details.'."\n", 'type' => 'string', 'example' => 'xxxxx', ], 'EventImpact' => [ 'description' => 'The event impact.'."\n", 'type' => 'string', 'example' => 'xxxxx'."\n", ], 'EventLevel' => [ 'description' => 'The level of the event. Valid values:'."\n" ."\n" .'* **INFO**'."\n" .'* **WARN**'."\n" .'* **CRITICAL**'."\n", 'type' => 'string', 'example' => 'INFO', ], 'EventReason' => [ 'description' => 'The event source.'."\n", 'type' => 'string', 'example' => 'xxxxx', ], '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', ], 'GmtCreated' => [ 'description' => 'The time when the event was created.'."\n", 'type' => 'string', 'example' => '2024-12-13 05:34:23', ], 'GmtModified' => [ 'description' => 'The time when the event was updated.'."\n", 'type' => 'string', 'example' => '2025-03-05 10:41:59', ], 'HandleStatus' => [ 'description' => 'The status of the event. Valid values:'."\n", 'type' => 'string', 'example' => 'done', ], 'HasLifeCycle' => [ 'description' => 'Indicates whether the event has a lifecycle.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'false', ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'r-bp15kjsoovqjam****', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'normandy', ], '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', ], 'Product' => [ 'description' => 'The name of the product.'."\n", 'type' => 'string', 'example' => 'kvstore', ], 'RegionId' => [ 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], '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', ], 'SourceType' => [ 'description' => 'The type of the source data.'."\n", 'type' => 'string', 'example' => 'MSE', ], 'StartTime' => [ 'description' => 'The start time of the event.'."\n", 'type' => 'string', 'example' => '2025-09-30T21:13Z', ], 'Uid' => [ 'description' => 'The ID of the user to which the resources belong.'."\n", 'type' => 'string', 'example' => '15532817595*****', ], ], ], ], ], ], ], 'description' => '', ], ], ], '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', ], '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', ], ], [ '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', ], ], [ 'name' => 'FromStartTime', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query. Only tasks that have a start time later than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The start time can be up to 30 days earlier than the current time. If you set this parameter to a time more than 30 days earlier than the current time, this time is automatically converted to a time that is exactly 30 days earlier than the current time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-01-02T11:31:03Z', ], ], [ 'name' => 'ToStartTime', 'in' => 'query', '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', ], ], ], '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****', ], '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', ], 'TotalCount' => [ 'description' => 'The total number of returned events.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '21', ], ], ], ], ], ], ], ], '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', ], '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****', ], ], [ 'name' => 'TargetZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the destination zone.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', ], ], [ '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', ], 'default' => '5', ], ], ], '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****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D9F3768-EDA9-4811-943E-42C8006E****\\"\\n}","type":"json"}]', 'title' => 'SwitchInstanceZoneFailOver', ], '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' => 'Safe', 'default' => 'Safe', 'enum' => [ 'Safe', 'UnSafe', 'Hard', 'Soft', ], ], ], [ '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', ], ], [ 'name' => 'ProxyInstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of the proxy nodes.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => '6981,6982', ], ], [ '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', ], ], ], [ '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', ], ], ], [ '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****', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => 'The resource category. Set the value to instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'instance', 'default' => 'instance', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '12123216-4B00-4378-BE4B-08005BFC****', ], 'DBInstanceId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'r-bp1zxszhcgatnx****', ], 'TaskID' => [ 'description' => 'The task ID.', 'type' => 'string', 'example' => '17566', ], ], ], ], ], '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', ], '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****', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => 'The ID of the order.'."\n", 'type' => 'string', 'example' => '236934422960904', ], 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', ], ], ], ], ], '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", ], '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', ], ], [ '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****', ], ], [ 'name' => 'StepName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the current step.'."\n", 'type' => 'string', 'required' => false, 'example' => 'exec_task', ], ], [ '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', ], ], [ '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\\"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2B98499B-E62B-56D4-8D7F-3D6D4DB260F2', ], 'ErrorTaskId' => [ 'description' => 'The ID of the failed task. This parameter is returned if a task fails.', 'type' => 'string', 'example' => 't-0mqaj5hnyofczv****', ], 'SuccessCount' => [ 'description' => 'The number of completed tasks.'."\n", 'type' => 'string', 'example' => '2', ], 'ErrorCode' => [ 'description' => 'The error code returned if a task fails.'."\n", 'type' => 'string', 'example' => 'mst.errorcode.success.errormessage', ], ], ], ], ], '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', ], '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', ], ], [ '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', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B560AAD5-5027-51AD-A0D4-FA4DB1A76F40\\"\\n}","type":"json"}]', 'title' => 'ModifyBackupExpireTime', ], 'DeleteBackup' => [ 'summary' => 'Deletes a specified backup set. However, you can delete only backup sets that are manually backed up.', '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' => '', 'type' => 'string', 'required' => true, 'example' => '521****66', ], ], [ '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****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'F14475F4-644E-51EA-B1E8-E4D442093D0C', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F14475F4-644E-51EA-B1E8-E4D442093D0C\\"\\n}","type":"json"}]', 'title' => 'DeleteBackup', ], 'CreateTairKVCacheVNode' => [ 'summary' => 'Creates 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 the instance resides.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing-f', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => 'The 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 or the following special characters: `@ / : = " < > { [ ] }`'."\n", 'type' => 'string', 'required' => false, 'example' => 'vnodetest', ], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'Instance specification'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'kvcache.cu.g4b.2'."\n", ], ], [ 'name' => 'ComputeUnitNum', 'in' => 'query', 'schema' => [ 'description' => 'The number of compute units. Valid values: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1', 'minimum' => '1', 'enumValueTitles' => [ 1 => '1', ], 'example' => '1', ], ], [ 'name' => 'VkName', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the VCluster that contains the VNode.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tk-2ze4bba3c8fe****'."\n", ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch to which the instance belongs. The vSwitch must belong to the VPC of the VCluser. You can call the [DescribeVpcs](~~35739~~) operation to query the VPC ID.'."\n" ."\n" .'> The vSwitch and the instance must be deployed in the same zone.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1e7clcw529l773d****', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The new billing method. Valid values:'."\n" ."\n" .'* **PrePaid**: subscription. If you set this parameter to PrePaid, you must also specify the **Period** parameter.'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'PrePaid' => 'PrePaid', ], 'example' => 'PrePaid', 'default' => 'PrePaid', 'enum' => [ 'PrePaid', 'PostPaid', ], ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration. Valid values: **1** to **9**, **12**, **24**, and **36**. Unit: months.'."\n" ."\n" .'> This parameter is required only if the **ChargeType** parameter is set to **PrePaid**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'BusinessInfo', 'in' => 'query', 'schema' => [ 'description' => 'The extended information such as the promotional event ID and business information.'."\n", 'type' => 'string', 'required' => false, 'example' => '000000000'."\n", ], ], [ 'name' => 'CouponNo', 'in' => 'query', 'schema' => [ 'description' => 'The coupon code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'default' => 'default', ], ], [ 'name' => 'AutoUseCoupon', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use a coupon. Valid values:'."\n" ."\n" .'* **true**: uses a coupon.'."\n" .'* **false**: does not use a coupon.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable auto-renewal for the instance. Default value: false. Valid values:'."\n" ."\n" .'* **true**: enabled'."\n" .'* **false**: disables auto-renewal.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration that is supported by auto-renewal. Unit: month. Valid values: **1**, **2**, **3**, **6**, and **12**.'."\n" ."\n" .'> This parameter is required if the **AutoRenew** parameter is set to **true**.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the resource group that you want to manage.'."\n" ."\n" .'> '."\n" ."\n" .'* You can query resource group IDs in the console or by calling the [ListResourceGroups](~~158855~~) operation. For more information, see [View the basic information about a resource group](~~151181~~).'."\n" ."\n" .'* Before you modify the resource group to which an instance belongs, you can call the [ListResources](~~158866~~) operation to view the current resource group of the instance.'."\n", 'type' => 'string', 'required' => false, 'maximum' => '4096', 'minimum' => '1', 'example' => 'rg-acfmyiu4ekp****', ], ], [ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable automatic payment. Set the value to **true**.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', 'enum' => [ 'true', ], ], ], [ '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 and is case-sensitive. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'Details of the tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Details of the tag.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key.'."\n" ."\n" .'> A maximum of five key-value pairs can be specified at a time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value1_test', ], 'Value' => [ 'description' => 'The value of tag N of the instance.'."\n" ."\n" .'> **N** specifies the value of the nth tag. For example, **Tag.1.Value** specifies the value of the first tag, and **Tag.2.Value** specifies the value of the second tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key1_test', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ '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 prechecks the request parameters, request format, service limits, and available resources. If the request fails to pass the precheck, an error message is returned. If the request passes the precheck, the `DryRunOperation` error code is returned.'."\n" .'* **false**: performs a dry run and performs the actual request. If the request passes the dry run, the instance is created.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'VNodeType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'default' => 'fixed', 'enum' => [ 'fixed', 'elastic', ], ], ], [ 'name' => 'ElasticTimeRange', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', ], 'InstanceId' => [ 'description' => 'The ID of the Tair VNode instance.'."\n", 'type' => 'string', 'example' => 'tv-2zeb1ce76fee****', ], 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20905403119****', ], 'RegionId' => [ 'description' => 'The ID of the region where the instance resides.'."\n", 'type' => 'string', 'example' => 'cn-beijing', ], 'ZoneId' => [ 'description' => 'The zone ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-beijing-f', ], 'VkName' => [ 'description' => 'The ID of the VCluster instance.'."\n", 'type' => 'string', 'example' => 'tk-2ze4bba3c8fe****'."\n", ], 'VClusterId' => [ 'description' => 'The ID of the VCluster.'."\n", 'type' => 'string', 'example' => 'vc-16965a9267*****-*****', ], 'NodeId' => [ 'description' => 'The ID of the VNode.'."\n", 'type' => 'string', 'example' => 'vn-03a49876edb****', ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'MissingParameter', 'errorMessage' => 'Period is mandatory for this action.', ], [ 'errorCode' => 'InvalidToken.Malformed', 'errorMessage' => 'The Specified parameter Token is not valid.', ], [ 'errorCode' => 'InvalidInstanceName.Malformed', 'errorMessage' => 'The Specified parameter InstanceName is not valid.', ], [ 'errorCode' => 'InvalidPassword.Malformed', 'errorMessage' => 'The Specified parameter Password is not valid.', ], [ 'errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account does not have enough balance.', ], [ 'errorCode' => 'QuotaExceed.AfterpayInstance', 'errorMessage' => 'Living afterpay instances quota exceeded.', ], [ 'errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', ], [ 'errorCode' => 'ResourceNotAvailable', 'errorMessage' => 'Resource you requested is not available for finance user.', ], [ 'errorCode' => 'PaymentMethodNotFound', 'errorMessage' => 'No payment method has been registered on the account.', ], [ 'errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'Request uses a client token in a previous request but is not identical to that request.', ], [ 'errorCode' => 'QuotaNotEnough', 'errorMessage' => 'Quota not enough in this zone.', ], [ 'errorCode' => 'QuotaExceed', 'errorMessage' => 'Living afterpay instances quota exceed.', ], [ 'errorCode' => 'VpcServiceError', 'errorMessage' => 'Invoke vpc service failed.', ], [ 'errorCode' => 'IzNotSupportVpcError', 'errorMessage' => 'Specify iz not support vpc.', ], [ 'errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The vpc does not cover the vswitch.', ], [ 'errorCode' => 'InvalidIzNo.NotSupported', 'errorMessage' => 'The Specified vpc zone not supported.', ], [ 'errorCode' => 'InvalidAccountPassword.Format', 'errorMessage' => 'Specified account password is not valid.', ], [ 'errorCode' => 'InstanceClass.NotMatch', 'errorMessage' => 'Current instance class and instance type is not match.', ], [ 'errorCode' => 'InvalidVPCId.NotFound', 'errorMessage' => 'Specified virtual vpc is not found.', ], [ 'errorCode' => 'AccountMoneyValidateError', 'errorMessage' => 'Account money validate error.', ], [ 'errorCode' => 'RequestTokenConflict', 'errorMessage' => 'Specified request token conflict.', ], [ 'errorCode' => 'InvalidIPNotInSubnet', 'errorMessage' => 'Error ip not in subnet.', ], [ 'errorCode' => 'InvalidEngineVersion.Malformed', 'errorMessage' => 'Specified engine version is not valid.', ], [ 'errorCode' => 'Zone.Closed', 'errorMessage' => 'The specified zone is closed.', ], [ 'errorCode' => 'VSwithNotBelongToNotVpcFault', 'errorMessage' => 'The vSwitch does not belong to current vpc.', ], [ 'errorCode' => 'PayIllegalAgreement', 'errorMessage' => 'Pay mayi with holding agreement illegal.', ], [ 'errorCode' => 'IllegalParamError', 'errorMessage' => 'validateSaleConditionWithSubArticle failed.', ], [ 'errorCode' => 'InvalidRegion.Format', 'errorMessage' => 'Specified Region is not valid.', ], ], 403 => [ [ 'errorCode' => 'RealNameAuthenticationError', 'errorMessage' => 'Your account has not passed the real-name authentication yet.', ], [ 'errorCode' => 'AuthorizationFailure', 'errorMessage' => 'The request processing has failed due to authorization failure.', ], [ 'errorCode' => 'TokenServiceError', 'errorMessage' => 'The specified token is duplicated, please change it.', ], [ 'errorCode' => 'UserCannotBuyNotInnerCommodity', 'errorMessage' => 'The user can not buy this commodity without alibaba group tag.', ], ], [ [ 'errorCode' => 'InvalidCapacity.NotFound', 'errorMessage' => 'The Capacity provided does not exist in our records.', ], [ 'errorCode' => 'InvalidvSwitchId', 'errorMessage' => 'The Specified vSwitchId zone not supported.', ], [ 'errorCode' => 'InvalidVpcIdOrVswitchId.NotSupported', 'errorMessage' => 'The Specified vpcId or vSwitchId not supported.', ], ], ], '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', ], 'DescribeTairKVCacheInferInstances' => [ 'summary' => 'Queries the information of one or more Tair (Redis OSS-compatible) 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 ID of the region where the instance resides.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'schema' => [ 'description' => 'The IDs of the instances that you want to query.'."\n" ."\n" .'> If you want to specify multiple instance IDs, separate the instance IDs with commas (,). You can specify a maximum of 30 instance IDs in a single request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tk-2zefe7728c2c****', ], ], [ 'name' => 'InstanceStatus', 'in' => 'query', 'schema' => [ 'description' => 'The state of the instance. Valid values:'."\n" ."\n" .'* **Normal**: The instance is normal.'."\n" .'* **Creating**: The instance is being created.'."\n" ."\n" .'> For more information about instance states, see [Instance states and impacts](~~200740~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Normal', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method of the simple application servers. Valid values:'."\n" ."\n" .'* **PrePaid**: subscription'."\n" .'* **PostPaid**: pay-as-you-go'."\n", 'type' => 'string', 'required' => false, 'example' => 'PrePaid', 'enum' => [ 'PrePaid', 'PostPaid', ], ], ], [ 'name' => 'NetworkType', 'in' => 'query', 'schema' => [ 'description' => 'The network type of the instance. Default value: VPC. Valid values:'."\n" ."\n" .'* **VPC** (default)'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* CLASSIC'."\n" .'* VPC'."\n", 'type' => 'string', 'required' => false, 'example' => 'VPC', 'enum' => [ 'CLASSIC', 'VPC', ], ], ], [ 'name' => 'InstanceClass', 'in' => 'query', 'schema' => [ 'description' => 'The instance type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'kvcache.cu.g4c.2', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1nme44gek34slfc****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1e7clcw529l773d****', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => 'The page number of the instance list. Start value: 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => 'The number of entries per page. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '0', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'SearchKey', 'in' => 'query', 'schema' => [ 'description' => 'The keyword that you want to use for fuzzy match. The keyword can be a part of an instance name or an instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'apitest', ], ], [ 'name' => 'Expired', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the instance has expired. Valid values:'."\n" ."\n" .'* **true**: The instance has expired.'."\n" .'* **false**: The instance has not expired.'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-e', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => 'The resource group ID. You can leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyiu4ekp****', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'Details of the tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Details of the tag.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key.'."\n" ."\n" .'> A maximum of five key-value pairs can be specified at a time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key1_test', ], 'Value' => [ 'description' => 'The value of tag N of the instance.'."\n" ."\n" .'> **N** specifies the value of the nth tag. For example, **Tag.1.Value** specifies the value of the first tag, and **Tag.2.Value** specifies the value of the second tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testvalue', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 21, ], ], [ 'name' => 'PrivateIp', 'in' => 'query', 'schema' => [ 'description' => 'The private IP address of the instance. This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.16.49.***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CD225838-7069-5CE4-89E1-67B83AC149C8', ], 'PageNumber' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'TotalCount' => [ 'description' => 'The total number of returned records.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'Instances' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TairInferInstanceDTO' => [ 'description' => 'The information about the returned Tair (Redis OSS-compatible) KVCache instance.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => 'The VPC ID of the instance.'."\n", 'type' => 'string', 'example' => 'vpc-2zef5w848p4j5g***', ], 'CreateTime' => [ 'description' => 'The creation time of the instance.'."\n", 'type' => 'string', 'example' => '2025-04-07T04:46Z', ], 'ChargeType' => [ 'description' => 'The billing method of the instance.'."\n", 'type' => 'string', 'example' => 'PostPaid', ], 'NetworkType' => [ 'description' => 'The network type of the instance.'."\n", 'type' => 'string', 'example' => 'VPC', ], 'InstanceName' => [ 'description' => 'The instance name.'."\n", 'type' => 'string', 'example' => 'kvcache-7', ], 'InstanceClass' => [ 'description' => 'The instance type.'."\n", 'type' => 'string', 'example' => 'kvcache.cu.g4b.2', ], 'DestroyTime' => [ 'description' => 'The time when the instance was deleted.'."\n", 'type' => 'string', 'example' => '2025-04-07T04:46Z'."\n", ], 'InstanceId' => [ 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'example' => 'tk-9dp7e37bab*****', ], 'InstanceType' => [ 'description' => 'The type of the instance. Valid values:'."\n" ."\n" .'* **TairInfer**: the inference operator instance'."\n" .'* **TairKVCacheVnode**: the virtual cluster instance.'."\n" .'* **TairKVCacheService**: the cache service instance.'."\n", 'type' => 'string', 'example' => 'TairInfer', ], 'RegionId' => [ 'description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'example' => 'cn-beijing', ], 'EndTime' => [ 'description' => 'The time when the subscription instance expires.'."\n", 'type' => 'string', 'example' => '2025-11-04T02:09:26Z', ], 'VSwitchId' => [ 'description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-8vbf0ksk774ai6q1d****', ], 'ResourceGroupId' => [ 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-acfm4bdru5z****', ], 'ZoneId' => [ 'description' => 'The zone ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou-g', ], 'InstanceStatus' => [ 'description' => 'The instance state. Valid values:'."\n" ."\n" .'* **Normal**: The instance is normal.'."\n" .'* **Creating**: The instance is being created.'."\n", 'type' => 'string', 'example' => 'Normal', ], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'Details of the tags.'."\n", 'type' => 'array', 'items' => [ 'description' => 'Details of the tag.'."\n", 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'thread', ], 'Value' => [ 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => '900', ], ], ], ], ], ], 'PrivateIp' => [ 'description' => 'The private IP address of the instance. This parameter is deprecated.'."\n", 'type' => 'string', 'example' => '172.16.49.***', ], 'Capacity' => [ 'description' => 'The capacity of the KVCache. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '256', ], 'Model' => [ 'description' => 'The built-in model of the inference operator instance.'."\n", 'type' => 'string', 'example' => 'DeepSeek-OCR', ], 'ModelServiceNum' => [ 'description' => 'The number of model services of the inference operator instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ComputeUnitNum' => [ 'description' => 'The number of compute units.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'VNodeName' => [ 'description' => 'The list of vNode instance names under the virtual cluster instance. This parameter is deprecated.'."\n", 'type' => 'string', 'example' => 'tv-xxxxx', ], 'AckId' => [ 'description' => 'The ACK cluster ID corresponding to the virtual cluster instance.'."\n", 'type' => 'string', 'example' => 'c809******************************', ], 'VNodeCount' => [ 'description' => 'The number of vNodes in the virtual cluster.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'FixedVNodeCount' => [ 'type' => 'integer', 'format' => 'int32', ], 'ElasticVNodeCount' => [ 'type' => 'integer', 'format' => 'int32', ], ], 'description' => '', ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidInstanceIds.Malformed', 'errorMessage' => 'The Specified parameter InstanceIds is not valid.', ], ], ], '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"}]', 'title' => 'DescribeTairKVCacheInferInstances', 'description' => 'You can call this operation to query the following Tair (Redis OSS-compatible) KVCache instances: inference operator instances, virtual cluster instances, and cache service instances.'."\n", ], 'TransformToEcs' => [ 'summary' => 'Converts an instance use local disks to a cloud-native instance.', '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 specification of the cloud-native instance. For more information, see [Overview](~~26350~~).'."\n", 'type' => 'string', 'required' => true, 'example' => 'tair.rdb.1g', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The new billing method. Valid values:'."\n" ."\n" .'* **PostPaid:** pay-as-you-go'."\n" .'* **PrePaid**: subscription. If you set this parameter to PrePaid, you must also specify the **Period** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PostPaid', 'default' => 'PostPaid', 'enum' => [ 'PrePaid', 'PostPaid', ], ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration of the instance. Unit: months. Valid values: **1**, 2, 3, 4, 5, 6, 7, 8, **9**, **12**, **24**, **36**.'."\n" ."\n" .'> This parameter is available and required only if the **ChargeType** parameter is set to **PrePaid**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ShardCount', 'in' => 'query', 'schema' => [ 'description' => 'The number of data shards in the cloud-native cluster instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the instance that you want to convert.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'description' => 'The database engine version of the instance. Valid values: **5.0**, **6.0**, and **7.0**.'."\n", 'type' => 'string', 'required' => true, 'example' => '5.0', 'enum' => [ '5.0', '6.0', '7.0', ], ], ], [ 'name' => 'EffectiveTime', 'in' => 'query', 'schema' => [ 'description' => 'The time when a database switchover is performed after data is migrated. Valid values:'."\n" ."\n" .'* **Immediately**: A database switchover is performed immediately after data is migrated.'."\n" .'* **MaintainTime**: A database switchover is performed during the maintenance window.'."\n" ."\n" .'> Default value: Immediately.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Immediately', 'default' => 'Immediately', 'enum' => [ 'Immediately', 'MaintainTime', ], ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to enable the auto-renewal feature. Valid values:'."\n" ."\n" .'* **true**: enables auto-renewal.'."\n" .'* **false**: does not enable auto-renewal.'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', 'enum' => [ 'true', 'false', ], ], ], [ 'name' => 'AutoRenewPeriod', 'in' => 'query', 'schema' => [ 'description' => 'The subscription duration that is supported by auto-renewal. Unit: month. Valid values: **1**, **2**, **3**, **6**, and **12**.'."\n" ."\n" .'> This parameter is required if the **AutoRenew** parameter is set to **true**.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'enum' => [ '1', '2', '3', '6', '12', ], ], ], [ 'name' => 'DryRun', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to perform a precheck before the system creates the instance. Valid values:'."\n" ."\n" .'* **true**: The system performs a dry run and does not create the cloud-native instance. The system prechecks the request parameters, request format, service limits, and available resources. If the request fails to pass the precheck, an error message is returned. If the request passes the precheck, the `DryRunOperation` error code is returned.'."\n" .'* **false**: performs a dry run and sends the request. If the request passes the dry run, the instance is created.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'DAABAD9B-890F-56C0-806C-6144946594AB', ], 'OrderId' => [ 'description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '20905403119****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DAABAD9B-890F-56C0-806C-6144946594AB\\",\\n \\"OrderId\\": \\"20905403119****\\"\\n}","type":"json"}]', 'title' => 'TransformToEcs', ], 'ModifyDBInstanceMonitor' => [ 'summary' => 'Modifies the monitoring granularity of a Tair (Redis OSS-compatible) 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 ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'r-bp1zxszhcgatnx****', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => 'The interval at which monitoring data is collected. Valid values: 5 and 60. Unit: seconds.'."\n", 'type' => 'string', 'required' => true, 'example' => '5', 'enum' => [ '5', '60', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', ], ], 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BE6E619-A657-42E3-AD2D-18F8428A****\\"\\n}","type":"json"}]', 'title' => 'ModifyDBInstanceMonitor', ], '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', ], ], [ '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', ], ], ], [ '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****', ], ], ], '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****', ], 'RequestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F3F44BE3-5419-4B61-9BAC-E66E295A****', ], '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', ], 'TagValues' => [ 'description' => 'The tag values.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The value of the tag'."\n", 'type' => 'string', 'example' => '[\'test_value_2\']', ], ], ], ], ], ], 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidTagKey.Malformed', 'errorMessage' => 'The specified parameter \'Tag.n.Key\' or \'TagKey.n\' is not valid.', ], [ 'errorCode' => 'InvalidTagValue.Malformed', 'errorMessage' => 'The specified parameter \'Tag.n.Value\' is not valid.', ], [ 'errorCode' => 'InvalidParameter.ResourceId', 'errorMessage' => 'The specified parameter \'ResourceId.n\' is not valid.', ], [ 'errorCode' => 'MissParameter.TagOrResourceId', 'errorMessage' => 'The parameter \'Tag.n\'\' or \'ResourceId.n\' is needed.', ], [ 'errorCode' => 'InvalidParameter.Scope', 'errorMessage' => 'The specified parameter \'Scope\' is not valid.', ], [ 'errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The ResourceIds parameter\'s number is exceed.', ], [ 'errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The Tags parameter\'s number is exceed.', ], [ 'errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The specified parameter \'Tag.n.Key\' is duplicated.', ], [ 'errorCode' => 'InvalidParameter.ResourceType', 'errorMessage' => 'The specified parameter \'ResourceType\' is not valid.', ], ], 404 => [ [ 'errorCode' => 'InvalidDbInstanceId.NotFound', 'errorMessage' => 'Specified instance does not exist.', ], ], ], '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', ], '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****', ], ], [ 'name' => 'SrcIp', 'in' => 'query', 'schema' => [ 'description' => 'The IP address of the client.'."\n", 'type' => 'string', 'required' => true, 'example' => '124.207.240.***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', ], 'ConnCheckResult' => [ 'description' => 'The connection check result. Valid values:'."\n" ."\n" .'* **Success**'."\n" .'* **Failed**'."\n", 'type' => 'string', 'example' => 'Failed', ], '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', ], 'ConnCheckErrorMessage' => [ 'description' => 'The error message for connection diagnosis.'."\n", 'type' => 'string', 'example' => 'Src ip:172.28.134.96 not in user whitelist', ], ], ], ], ], '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', ], ], 'endpoints' => [ [ 'regionId' => 'cn-qingdao', 'endpoint' => 'r-kvstore.cn-qingdao.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'r-kvstore.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'r-kvstore.cn-zhangjiakou.aliyuncs.com', ], [ 'regionId' => 'cn-zhengzhou-jva', 'endpoint' => 'r-kvstore.cn-zhengzhou-jva.aliyuncs.com', ], [ 'regionId' => 'cn-huhehaote', 'endpoint' => 'r-kvstore.cn-huhehaote.aliyuncs.com', ], [ 'regionId' => 'cn-wulanchabu', 'endpoint' => 'r-kvstore.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'r-kvstore.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'r-kvstore.aliyuncs.com', ], [ 'regionId' => 'cn-nanjing', 'endpoint' => 'r-kvstore.cn-nanjing.aliyuncs.com', ], [ 'regionId' => 'cn-fuzhou', 'endpoint' => 'r-kvstore.cn-fuzhou.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'r-kvstore.cn-shenzhen.aliyuncs.com', ], [ 'regionId' => 'cn-heyuan', 'endpoint' => 'r-kvstore.aliyuncs.com', ], [ 'regionId' => 'cn-guangzhou', 'endpoint' => 'r-kvstore.cn-guangzhou.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'r-kvstore.cn-chengdu.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'r-kvstore.cn-hongkong.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'r-kvstore.ap-northeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-2', 'endpoint' => 'r-kvstore.ap-northeast-2.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'r-kvstore.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-2', 'endpoint' => 'r-kvstore.ap-southeast-2.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'r-kvstore.ap-southeast-3.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'r-kvstore.ap-southeast-5.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-6', 'endpoint' => 'r-kvstore.ap-southeast-6.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'r-kvstore.us-east-1.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'r-kvstore.us-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-west-1', 'endpoint' => 'r-kvstore.eu-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'r-kvstore.eu-central-1.aliyuncs.com', ], [ 'regionId' => 'ap-south-1', 'endpoint' => 'r-kvstore.ap-south-1.aliyuncs.com', ], [ 'regionId' => 'me-east-1', 'endpoint' => 'r-kvstore.me-east-1.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-finance', 'endpoint' => 'r-kvstore.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'r-kvstore.cn-shanghai-finance-1.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'r-kvstore.cn-shenzhen-finance-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-7', 'endpoint' => 'r-kvstore.ap-southeast-7.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-finance-1', 'endpoint' => 'r-kvstore.cn-beijing-finance-1.aliyuncs.com', ], [ 'regionId' => 'me-central-1', 'endpoint' => 'r-kvstore.me-central-1.aliyuncs.com', ], [ 'regionId' => 'cn-wuhan-lr', 'endpoint' => 'r-kvstore.cn-wuhan-lr.aliyuncs.com', ], [ 'regionId' => 'na-south-1', 'endpoint' => 'r-kvstore.na-south-1.aliyuncs.com', ], [ 'regionId' => 'us-southeast-1', 'endpoint' => 'r-kvstore.us-southeast-1.aliyuncs.com', ], ], ];