From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/zh_cn/r-kvstore/2015-01-01/api-docs.php | 26251 +++++++++++++++++++++++++ 1 file changed, 26251 insertions(+) create mode 100644 data/zh_cn/r-kvstore/2015-01-01/api-docs.php (limited to 'data/zh_cn/r-kvstore') diff --git a/data/zh_cn/r-kvstore/2015-01-01/api-docs.php b/data/zh_cn/r-kvstore/2015-01-01/api-docs.php new file mode 100644 index 0000000..d24c4bb --- /dev/null +++ b/data/zh_cn/r-kvstore/2015-01-01/api-docs.php @@ -0,0 +1,26251 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'R-kvstore', + 'version' => '2015-01-01', + ], + 'directories' => [ + [ + 'id' => 67090, + 'title' => '生命周期管理', + 'type' => 'directory', + 'children' => [ + 'CreateInstance', + 'AddShardingNode', + 'CreateGlobalDistributeCache', + 'DeleteShardingNode', + 'DeleteInstance', + 'DestroyInstance', + 'ModifyInstanceSpec', + 'DescribeRegions', + 'DescribeZones', + 'DescribeAvailableResource', + 'TransformToPrePaid', + 'MigrateToOtherZone', + ], + ], + [ + 'id' => 67103, + 'title' => '实例管理', + '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' => '连接管理', + 'type' => 'directory', + 'children' => [ + 'ModifyInstanceNetExpireTime', + 'ModifyDBInstanceConnectionString', + 'ModifyIntranetAttribute', + 'DescribeIntranetAttribute', + 'SwitchNetwork', + 'AllocateInstancePublicConnection', + 'ReleaseInstancePublicConnection', + 'AllocateDirectConnection', + 'ReleaseDirectConnection', + 'SwitchInstanceProxy', + ], + ], + [ + 'id' => 67137, + 'title' => '续费管理', + 'type' => 'directory', + 'children' => [ + 'ModifyInstanceAutoRenewalAttribute', + 'DescribePrice', + 'DescribeInstanceAutoRenewalAttribute', + 'RenewAdditionalBandwidth', + 'TransformInstanceChargeType', + 'RenewInstance', + ], + ], + [ + 'id' => 67144, + 'title' => '账号管理', + 'type' => 'directory', + 'children' => [ + 'CreateAccount', + 'DeleteAccount', + 'ModifyAccountDescription', + 'ModifyAccountPassword', + 'DescribeAccounts', + 'ResetAccountPassword', + 'GrantAccountPrivilege', + ], + ], + [ + 'id' => 67152, + 'title' => '备份恢复', + 'type' => 'directory', + 'children' => [ + 'CreateBackup', + 'ModifyBackupPolicy', + 'DescribeBackupTasks', + 'DescribeBackupPolicy', + 'DescribeBackups', + 'RestoreInstance', + 'DescribeClusterBackupList', + ], + ], + [ + 'id' => 67159, + 'title' => '监控管理', + 'type' => 'directory', + 'children' => [ + 'DescribeDBInstanceMonitor', + 'DescribeMonitorItems', + 'DescribeHistoryMonitorValues', + ], + ], + [ + 'id' => 67162, + 'title' => '日志管理', + 'type' => 'directory', + 'children' => [ + 'ModifyAuditLogConfig', + 'DescribeAuditLogConfig', + 'DescribeAuditRecords', + 'DescribeRunningLogRecords', + 'DescribeSlowLogRecords', + 'InitializeKvstorePermission', + 'DescribeServiceLinkedRoleExists', + ], + ], + [ + 'id' => 67168, + 'title' => '网络安全', + 'type' => 'directory', + 'children' => [ + 'ModifySecurityIps', + 'ModifySecurityGroupConfiguration', + 'ModifyInstanceSSL', + 'ModifyInstanceVpcAuthMode', + 'DescribeSecurityIps', + 'DescribeSecurityGroupConfiguration', + 'DescribeInstanceSSL', + ], + ], + [ + 'id' => 67176, + 'title' => '参数管理', + 'type' => 'directory', + 'children' => [ + 'ModifyInstanceConfig', + 'DescribeParameterTemplates', + 'DescribeInstanceConfig', + 'DescribeParameters', + 'DescribeParameterModificationHistory', + ], + ], + [ + 'id' => 67181, + 'title' => '标签管理', + 'type' => 'directory', + 'children' => [ + 'ListTagResources', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 67185, + 'title' => '性能优化', + 'type' => 'directory', + 'children' => [ + 'CreateCacheAnalysisTask', + 'DescribeCacheAnalysisReport', + 'DescribeCacheAnalysisReportList', + ], + ], + [ + 'id' => 177761, + 'title' => '数据加密', + 'type' => 'directory', + 'children' => [ + 'ModifyInstanceTDE', + 'DescribeInstanceTDEStatus', + 'DescribeEncryptionKeyList', + 'DescribeEncryptionKey', + 'CheckCloudResourceAuthorized', + ], + ], + [ + 'id' => 67189, + 'title' => '运维任务管理', + 'type' => 'directory', + 'children' => [ + 'DescribeActiveOperationTaskCount', + 'DescribeHistoryTasks', + 'DescribeHistoryTasksStat', + 'ModifyActiveOperationTask', + 'DescribeActiveOperationTask', + 'DescribeActiveOperationMaintenanceConfig', + 'ModifyActiveOperationMaintainConfig', + ], + ], + [ + 'id' => 187216, + 'title' => '白名单模板管理', + 'type' => 'directory', + 'children' => [ + 'CreateGlobalSecurityIPGroup', + 'ModifyGlobalSecurityIPGroupName', + 'DescribeGlobalSecurityIPGroupRelation', + 'DeleteGlobalSecurityIPGroup', + 'ModifyGlobalSecurityIPGroup', + 'ModifyGlobalSecurityIPGroupRelation', + 'DescribeGlobalSecurityIPGroup', + ], + ], + [ + 'id' => 192365, + 'title' => '参数模板管理', + 'type' => 'directory', + 'children' => [ + 'ModifyInstanceParameter', + 'DeleteParameterGroup', + 'DescribeParameterGroupSupportParam', + 'DescribeParameterGroup', + 'ModifyParameterGroup', + 'DescribeParameterGroups', + 'CreateParameterGroup', + 'DescribeParameterGroupTemplateList', + ], + ], + [ + 'id' => 198610, + 'title' => '事件管理', + 'type' => 'directory', + 'children' => [ + 'DescribeActiveOperationTasks', + 'ModifyActiveOperationTasks', + 'CancelActiveOperationTasks', + 'ModifyEventInfo', + 'DescribeHistoryEvents', + 'DescribeHistoryEventsStat', + ], + ], + [ + 'id' => 198611, + 'title' => '故障模拟', + 'type' => 'directory', + 'children' => [ + 'SwitchInstanceZoneFailOver', + 'MasterNodeShutDownFailOver', + ], + ], + [ + 'id' => 198142, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'ModifyInstanceBandwidth', + 'ModifyTaskInfo', + 'ModifyBackupExpireTime', + 'DeleteBackup', + 'CreateTairKVCacheVNode', + 'DescribeTairKVCacheInferInstances', + 'TransformToEcs', + 'ModifyDBInstanceMonitor', + 'DescribeTags', + 'DescribeDbInstanceConnectivity', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateInstance' => [ + 'summary' => '创建一个Redis开源版或Tair内存型经典版实例。若要创建云原生型的Tair实例，请使用CreateTairInstance接口。', + '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' => '地域ID，可调用[DescribeRegions](~~473763~~)查询，使用此参数指定要创建实例的地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称。 名称为2~80个字符，以大小写字母或中文开头，不支持字符`@/:=”<>{[]}`和空格。', + 'type' => 'string', + 'required' => false, + 'example' => 'apitest', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '实例密码。 长度为8－32位，需包含大写字母、小写字母、特殊字符和数字中的至少三种，允许的特殊字符包括`!@#$%^&*()_+-=`。', + 'type' => 'string', + 'required' => false, + 'example' => 'Pass!123456', + ], + ], + [ + 'name' => 'Capacity', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的存储容量，单位为MB。'."\n" + ."\n" + .'> 调用此接口需至少传递**Capacity**或**InstanceClass**中的一个参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '16384', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的规格，例如redis.master.small.default为社区版（经典版）标准架构双副本1GB实例，详细信息请参见[规格查询导航](~~26350~~)。 '."\n" + ."\n" + .'> 调用此接口需至少传递**Capacity**或**InstanceClass**中的一个参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'redis.master.small.default', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '主可用区ID，可调用[DescribeRegions](~~473763~~)查询，使用此参数指定要创建实例的可用区。'."\n" + .'> 您也可以再传入SecondaryZoneId参数指定备可用区，主备节点将分别部署在指定的主可用区和备可用区，实现同城双中心主备架构。例如指定ZoneId参数为"cn-hangzhou-h"，指定SecondaryZoneId参数为"cn-hangzhou-g"。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区ID，可调用[DescribeZones](~~473764~~)接口查询。'."\n" + .'> 本参数和ZoneId参数传入的值不能相同，且不可传入多可用区对应的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值：'."\n" + .'* **PrePaid**：预付费。'."\n" + .'* **PostPaid**（默认）：按量付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'default' => 'PostPaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型，取值：'."\n" + .'* **MASTER_SLAVE**：高可用（双副本）'."\n" + .'* **STAND_ALONE**：单副本'."\n" + .'* **double**：双副本'."\n" + .'* **single**：单副本'."\n" + .'> 云原生版实例请选择**MASTER_SLAVE**或**STAND_ALONE**，经典版实例请选择**double**或**single**。', + 'type' => 'string', + 'required' => false, + 'example' => 'STAND_ALONE', + 'default' => 'double', + 'enum' => [ + 'STAND_ALONE', + 'MASTER_SLAVE', + 'double', + 'single', + ], + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '网络类型，取值：'."\n" + .'* **VPC**：专有网络，默认值。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + 'default' => 'VPC', + 'enum' => [ + 'VPC', + ], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC网络的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '付费周期，单位为月，取值：**1**~**9**、**12**、**24**、**36**、**60** 。'."\n" + ."\n" + .'> **ChargeType**取值为**PrePaid**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => '12', + 'pattern' => '^\\d+$', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '活动ID、业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '000000000', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠码，默认值为：`default`。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'default' => 'default', + ], + ], + [ + 'name' => 'SrcDBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '如需基于某个实例的备份集创建新实例，请先在此参数中指定源实例ID。'."\n" + .'> 然后通过**BackupId**、**ClusterBackupId**（云原生集群架构建议使用ClusterBackupId）或**RestoreTime**参数指定需要使用的备份集或指定时间点，本参数需要与上述3个中的任意一个参数组合使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '您可在此参数中指定源实例的备份集ID，系统将使用该备份集中保存的数据创建新实例。通过调用[DescribeBackups](~~473823~~)可查询BackupId。如果源实例是集群实例，则此处需要填写源实例各个分片的备份集id，并且通过逗号隔开，例如"10**,11**,15**"。'."\n" + .'> 若您的实例是云原生架构实例，并且是集群实例，则建议您使用[DescribeClusterBackupList](~~2679168~~)查询出集群备份集id，例如"cb-xx"，然后填入ClusterBackupId请求参数来达到克隆集群实例的目的，免去您输入各个分片备份集id的烦恼。', + 'type' => 'string', + 'required' => false, + 'example' => '111111111', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型，取值：'."\n" + .'* **Redis**（默认）'."\n" + .'* **Memcache**', + 'type' => 'string', + 'required' => false, + 'example' => 'Redis', + 'default' => 'Redis', + 'enum' => [ + 'Redis', + 'Memcache', + ], + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Redis**经典版本**，版本号取值：'."\n" + .'* **2.8**（不推荐，[计划停止全面支持](~~2674657~~)）'."\n" + .'* **4.0**（不推荐）'."\n" + .'* **5.0**'."\n" + ."\n" + .'Redis**云原生版本**，版本号取值：'."\n" + .'* **5.0**'."\n" + .'* **6.0**（推荐）'."\n" + .'* **7.0**'."\n" + ."\n" + .'> 默认值为**5.0**。', + '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' => '5.0', + 'default' => '5.0', + 'enum' => [ + '2.8', + '4.0', + '5.0', + '6.0', + '7.0', + ], + ], + ], + [ + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '指定新实例的内网IP地址。'."\n" + ."\n" + .'> 内网IP需在实例所属的交换机网段内。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.0.***', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用代金券，取值：'."\n" + .'* **true**：使用代金券。'."\n" + .'* **false**（默认）：不使用代金券。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费，取值：'."\n" + .'* **true**：开启。'."\n" + .'* **false**（默认）：不开启。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费周期，单位为月，取值：**1**、**2**、**3**、**6**、**12**。'."\n" + ."\n" + .'> 当**AutoRenew**取值为**true**时，本参数必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-resourcegroupid1', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => '若源实例已开启数据闪回，您可在此参数中指定源实例备份保留周期内的任意时间点，系统将使用源实例在该时间点的备份数据创建新实例。格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-06-19T16:00:00Z', + ], + ], + [ + 'name' => 'DedicatedHostGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '专属集群ID，在专属集群内创建Redis实例时需传入本参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'dhg-uv4fnk6r7zff****', + ], + ], + [ + 'name' => 'ShardCount', + 'in' => 'query', + 'schema' => [ + 'description' => '分片数，本参数仅适用于创建云原生版集群架构实例，您可以通过该参数实现自定义分片数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '128', + 'minimum' => '1', + 'example' => '4', + 'default' => '1', + ], + ], + [ + 'name' => 'ReplicaCount', + 'in' => 'query', + 'schema' => [ + 'description' => '主可用区的备节点，本参数仅适用于创建云原生版集群多副本实例，您可以通过该参数实现自定义备节点数量，取值：1~4。'."\n" + ."\n" + .'> 若创建多可用区实例，您可以通过该参数与SlaveReplicaCount参数自定义主、备可用区的备节点数量。同时，该参数与SlaveReplicaCount参数的总和不能超过4。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'SlaveReplicaCount', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区的备节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'ReadOnlyCount', + 'in' => 'query', + 'schema' => [ + 'description' => '主可用区的只读节点数，本参数仅适用于创建云原生读写分离实例。'."\n" + .'* 若实例为标准架构，取值为1~9。'."\n" + .'* 若实例为集群架构，取值为1-4，表示每数据分片的只读节点数。'."\n" + .'> 若创建多可用区实例，您可以通过该参数和SlaveReadOnlyCount参数自定义主备可用区的只读节点数量。'."\n" + .'> - 若实例为标准架构，该参数与SlaveReadOnlyCount的总和不能大于9。'."\n" + .'> - 若实例为集群架构，该参数与SlaveReadOnlyCount的总和不能大于4。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '5', + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'SlaveReadOnlyCount', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区的只读节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'GlobalInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '分布式实例ID，本参数仅适用于中国站。'."\n" + ."\n" + .' 如需将新创建的Redis实例追加为分布式实例中的新子实例，本参数才可用且必须传入。相关说明与控制台操作，请参见[为分布式实例添加子实例](~~106885~~)。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gr-bp14rkqrhac****', + ], + ], + [ + 'name' => 'GlobalInstance', + 'in' => 'query', + 'schema' => [ + 'description' => '是否将本次新建的实例作为分布式实例中的第一个子实例，通过该方式可创建分布实例，取值：'."\n" + ."\n" + .'* **true**：作为第一个子实例。'."\n" + .'* **false**（默认）：不作为第一个子实例。'."\n" + ."\n" + .'> * 如需传入**true**，本次新建的实例需为Tair内存型，引擎版本为5.0。'."\n" + .'> * 本参数仅适用于中国站。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的服务端口，取值范围：**1**~**65535**，默认值为**6379**。', + 'type' => 'string', + 'required' => false, + 'example' => '6379', + 'maxLength' => 5, + 'minLength' => 1, + 'pattern' => '^\\d+$', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对本次创建实例的操作执行预检查，取值：'."\n" + .'* **true**：执行预检查操作，不创建实例。检查项目包含请求参数、请求格式、业务限制和库存。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'* **false**（默认）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'GlobalSecurityGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的全局IP白名单模板，多个IP白名单模板请用英文逗号（,）分隔，不可重复。'."\n" + .'>该参数仅适用于云原生实例，经典版实例不支持白名单模板功能。>', + 'type' => 'string', + 'required' => false, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'Appendonly', + 'in' => 'query', + 'schema' => [ + 'description' => '指定新创建实例的AOF参数配置，取值：'."\n" + .'- **yes**（默认）：开启AOF持久化。'."\n" + .'- **no**：关闭AOF持久化。'."\n" + .'> 该参数适用于经典版实例，云原生版实例暂不支持指定AOF参数。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'no' => '关闭AOF', + 'yes' => '开启AOF', + ], + 'example' => 'yes', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '连接地址的前缀，需由小写英文字母与数字组成，以小写字母开头，长度为8~40个字符。'."\n" + ."\n" + .'> '."\n" + .'> 连接地址格式为：<前缀>.redis.rds.aliyuncs.com。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'ParamGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模板ID，全局唯一。>仅支持云原生实例>', + 'type' => 'string', + 'required' => false, + 'example' => 'rpg-test**', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例的标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键。'."\n" + ."\n" + .'> * **N**表示传入第几个标签的键，单个实例最多可绑定20个标签。例如Tag.1.Key表示传入第一个标签的键；Tag.2.Key表示传入第二个标签的键。'."\n" + .'> * 如果标签的键不存在，则自动创建。', + 'type' => 'string', + 'required' => false, + 'example' => 'testkey', + ], + 'Value' => [ + 'description' => '标签的值。'."\n" + .'> **N**表示传入第几个标签的值。例如**Tag.1.Value**表示传入第一个标签的值；**Tag.2.Value**表示传入第二个标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ClusterBackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '部分新集群架构支持集群备份集ID，您可以通过[DescribeClusterBackupList](~~2679168~~)接口获取。'."\n" + .'* 若支持，可输入指定的集群备份集ID即可，无需再填写**BackupId**参数。'."\n" + .'* 若不支持，请在BackupId参数中填写为原实例各个分片下的备份集ID，通过逗号隔开，例如"2158\\*\\*\\*\\*20,2158\\*\\*\\*\\*22"等。', + 'type' => 'string', + 'required' => false, + 'example' => 'cb-hyxdof5x9kqb****', + ], + ], + [ + 'name' => 'RecoverConfigMode', + 'in' => 'query', + 'schema' => [ + 'description' => '使用指定备份集创建实例时，是否从原备份集中恢复账号（account）、内核参数（config）、白名单（whitelist）信息。例如需恢复账号信息，则取值为`account`。'."\n" + ."\n" + .'默认为空，表示不从原备份集中恢复账号、内核参数、白名单信息。'."\n" + .'> 本参数仅适用于云原生版实例，且需要原备份集中已保存了账号、内核参数、白名单信息。您可以通过[DescribeBackups](~~473823~~)接口查询指定备份集中的RecoverConfigMode参数是否包含上述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'whitelist,config,account', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络（VPC）的ID。', + 'type' => 'string', + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + 'QPS' => [ + 'description' => '每秒访问次数，此处为当前规格实例的理论值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'Capacity' => [ + 'description' => '实例的存储容量，单位：MB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16384', + ], + 'ConnectionDomain' => [ + 'description' => 'Redis实例的内网连接地址。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', + ], + 'ChargeType' => [ + 'description' => '付费类型，返回值：'."\n" + .'* **PrePaid**：预付费。'."\n" + .'* **PostPaid**：按量付费。', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'NetworkType' => [ + 'description' => '网络类型，返回值：'."\n" + .'* **CLASSIC**：经典网络。'."\n" + .'* **VPC**：专有网络。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'InstanceId' => [ + 'description' => '实例ID（全局唯一）。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'Port' => [ + 'description' => 'Redis服务端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6379', + ], + 'Config' => [ + 'description' => '实例的详细配置。', + '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' => '实例所在地域。', + 'type' => 'string', + 'example' => 'cn-hongkong', + ], + 'EndTime' => [ + 'description' => '预付费实例到期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2019-01-18T16:00:00Z', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5DEA3CC9-F81D-4387-8E97-CEA40F09****', + ], + 'NodeType' => [ + 'description' => '节点类型，返回值：'."\n" + .'* **STAND_ALONE**：单副本。'."\n" + .'* **MASTER_SLAVE**：双副本。', + 'type' => 'string', + 'example' => 'MASTER_SLAVE', + ], + 'Connections' => [ + 'description' => '实例连接数限制。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'Bandwidth' => [ + 'description' => '实例带宽限制，单位：MB/s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'apitest', + ], + 'ZoneId' => [ + 'description' => '实例所属的可用区的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'InstanceStatus' => [ + 'description' => '实例的当前状态，返回值固定为Creating（创建中）。', + 'type' => 'string', + 'example' => 'Creating', + ], + 'PrivateIpAddr' => [ + 'description' => '实例的内网IP地址。', + 'type' => 'string', + 'example' => '172.16.0.10', + ], + 'UserName' => [ + 'description' => '连接Redis的账号，默认包含一个以实例ID命名的账号。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'OrderId' => [ + 'description' => '订单id。', + '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' => '创建实例', + 'description' => '请确保在使用该接口前，已充分了解云数据库 Tair（兼容 Redis）产品的收费方式和[价格](~~54532~~)。'."\n" + ."\n" + .'本接口可创建Redis开源版实例、Tair内存型经典版实例，如需创建Tair云原生版实例，请调用[CreateTairInstance](~~473770~~)接口。'."\n" + ."\n" + .'> 该API对应的控制台操作方法和选型建议，请参见[创建Redis实例](~~26351~~)。', + 'requestParamsDescription' => '创建Redis 7.0集群架构的请求示例如下。'."\n" + .'
{'."\n"
+                .'  "RegionId": "cn-shenzhen",'."\n"
+                .'  "InstanceName": "apitest",'."\n"
+                .'  "Password": "D****23",'."\n"
+                .'  "ZoneId": "cn-shenzhen-f",'."\n"
+                .'  "ChargeType": "PrePaid",'."\n"
+                .'  "InstanceClass": "redis.shard.with.proxy.small.ce",'."\n"
+                .'  "NetworkType": "VPC",'."\n"
+                .'  "Period": "1",'."\n"
+                .'  "InstanceType": "Redis",'."\n"
+                .'  "EngineVersion": "7.0",'."\n"
+                .'  "ShardCount": 4,'."\n"
+                .'  "SourceIp": "10.10.10.10"'."\n"
+                .'}
', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddShardingNode' => [ + 'summary' => '为集群实例添加数据分片节点，本接口仅支持集群架构云原生版实例。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'ShardCount', + 'in' => 'query', + 'schema' => [ + 'description' => '需要添加分片数量，默认值为**1**。'."\n" + .'> 实例总分片数最少为2个，单次操作的分片数上限为64，实例总分片数上限为256，请确保分片数不超过此限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '4096', + 'minimum' => '1', + 'example' => '2', + 'default' => '1', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付款，取值：'."\n" + .'* **true**：自动付款，请确保账号有足够的余额。'."\n" + .'* **false**：手动付款，您需要通过控制台手动续费，详情请参见[手动续费](~~26352~~)。'."\n" + ."\n" + .'> 默认值为**true**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'true', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠券编号。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'default' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '附加参数，业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '000000000', + ], + ], + [ + 'name' => 'SourceBiz', + 'in' => 'query', + 'schema' => [ + 'description' => '调用来源，本参数仅用于内部维护使用，无需传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'SDK', + ], + ], + [ + 'name' => 'ForceTrans', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启强制传输，取值：'."\n" + .'- **false**（默认）：在变配前，系统会检查实例当前的内核小版本，若内核版本过低则会报错，您需要升级内核小版本后重试。'."\n" + .'- **true**：跳过检查项，直接执行变配操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '支持指定同VPC下的不同交换机ID，新的数据分片将创建在指定的交换机下。'."\n" + .'若不填，则默认创建在原来的交换机中。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B79C1A90-495B-4E99-A2AA-A4DB13B8****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20741011111111', + ], + 'NodeIds' => [ + 'description' => '数据分片节点ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据分片节点ID。', + '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' => '为集群实例添加数据分片节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateGlobalDistributeCache' => [ + 'summary' => '将一个存量的Tair内存型（经典版）实例转换为分布式实例中第一个子实例。', + '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' => '待转换的实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + .'> 系统参数无需传入。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '执行时间，取值：'."\n" + .'* **Immediately**：立即执行。'."\n" + .'* **MaintainTime**：在可维护时间段执行，默认值。'."\n" + ."\n" + .'> 您可以调用[ModifyInstanceMaintainTime](~~473775~~)接口修改实例的可维护时间段。', + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => 'MaintainTime', + 'enum' => [ + 'Immediately', + 'MaintainTime', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E681E498-5A0D-44F2-B1A7-912DC3******', + ], + 'GlobalInstanceId' => [ + 'description' => '分布式实例ID。', + 'type' => 'string', + 'example' => 'gr-8vbzg1y6m****t38p', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-8vb6ffc5****4ec4', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E681E498-5A0D-44F2-B1A7-912DC3******\\",\\n \\"GlobalInstanceId\\": \\"gr-8vbzg1y6m****t38p\\",\\n \\"InstanceId\\": \\"r-8vb6ffc5****4ec4\\"\\n}","type":"json"}]', + 'title' => '将存量实例转换为分布式实例中第一个子实例', + 'description' => '您可以调用本接口指定一个已有的实例转换为分布式实例中第一个子实例，转换完成后，该实例所属的分布式实例即被创建成功。'."\n" + .'待转换的实例需满足下述要求：'."\n" + .'* 待转换的实例为Tair[内存型](~~126164~~)经典版。'."\n" + .'* 待转换的实例为集群架构时，需关闭直连模式，详情请参见[释放直连地址](~~150047~~)。'."\n" + ."\n" + .'> 您也可以调用[CreateInstance](~~473757~~)新购一个实例，该实例将作为分布式实例中的第一个子实例，子实例创建完成后，子实例所属的分布式实例即被创建成功。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteShardingNode' => [ + 'summary' => '删除集群实例中的数据分片节点，本接口仅支持集群架构云原生版实例。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的数据分片节点ID，如需一次传入多个分片节点ID，请使用英文逗号（,）分隔。'."\n" + .'> 若同时传递NodeId与ShardCount参数时，优先以NodeId参数执行。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****-db-0,r-bp1zxszhcgatnx****-db-1', + ], + ], + [ + 'name' => 'ShardCount', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的分片数量，将从尾部开始计数，删除相应数量的分片节点。'."\n" + .'> 例如实例原有5个分片节点，分别为db-0、db-1、db-2、db-3和db-4，输入本参数为2，则将删除db-3和db-4。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '4096', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ForceTrans', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启强制传输，取值：'."\n" + .'- **false**（默认）：在变配前，系统会检查实例当前的内核小版本，若内核版本过低则会报错，您需要升级内核小版本后重试。'."\n" + .'- **true**：跳过检查项，直接执行变配操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '代理模式集群实例删除分片时，若有删除proxy行为，执行该行为的时间，取值：'."\n" + .'* **0 或 Immediately**：立即执行，默认值。'."\n" + .'* **1 或 MaintainTime**：在可维护时间段执行。'."\n" + ."\n" + .'> 您可以调用[ModifyInstanceMaintainTime](~~473775~~)修改实例的可维护时间段。', + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => '0', + 'enum' => [ + '0', + '1', + 'Immediately', + 'MaintainTime', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', + ], + 'OrderId' => [ + 'description' => '订单号。您可以在费用中心的商品订单中，根据此订单号获取该订单的详细信息。', + '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' => '删除集群实例中的数据分片节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteInstance' => [ + 'summary' => '释放云数据库 Tair（兼容 Redis）实例。', + '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' => '待释放的实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'GlobalInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '待释放的实例所属的分布式实例ID，本参数仅适用于中国站。', + 'type' => 'string', + 'required' => false, + 'example' => 'gr-bp14rkqrhac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '释放实例', + 'description' => '该API对应的控制台操作请参见[释放实例](~~43882~~)。'."\n" + ."\n" + .'调用本接口时，实例必须满足以下条件：'."\n" + .'* 实例状态为运行中。'."\n" + .'* 实例的付费方式为后付费（按量付费）。'."\n" + ."\n" + .'> 预付费（包年包月）实例无法调用此接口主动删除，到期后将自动释放。 如需提前释放，请在控制台进行操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'DestroyInstance' => [ + 'summary' => '彻底销毁回收站中的实例及其数据备份', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '56452', + 'abilityTreeNodes' => [ + 'FEATUREkvstoreSIWMD9', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '回收站中的实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-8vb2rhccnvd82f****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '870422DE-B64C-5A15-9C48-4A9485D1****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"870422DE-B64C-5A15-9C48-4A9485D1****\\"\\n}","type":"json"}]', + 'title' => '销毁回收站中的实例', + 'description' => '调用本接口时，实例需存在于回收站中。详细介绍，请参见[实例回收站](~~86114~~)'."\n" + .'> 调用本接口后会彻底删除回收站中实例及其数据备份。'."\n" + ."\n" + .'执行该操作后，实例的数据将被彻底删除且无法找回，请谨慎操作。>', + ], + 'ModifyInstanceSpec' => [ + 'summary' => '变更云数据库 Tair（兼容 Redis）实例的规格。', + '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' => '地域ID，可调用[DescribeRegions](~~473763~~)查询，使用此参数指定要变更实例的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '变更后的实例规格代码，您可以调用[DescribeAvailableResource](~~473765~~)查询实例所属的可用区可以变配的规格。'."\n" + ."\n" + .'> 各规格的详情，请参见[规格查询导航](~~26350~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'redis.master.small.default', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '活动ID、业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '000000001', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠码，默认值：`youhuiquan_promotion_option_id_for_blank`。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'default' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'ForceUpgrade', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制变配，取值：'."\n" + .'* **false**：不强制变配。'."\n" + .'* **true**：强制变配，默认值。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '变更执行时间，取值：'."\n" + .'* **Immediately**：立即执行，默认值。'."\n" + .'* **MaintainTime**：在实例的可维护时间段执行，您可以调用[ModifyInstanceMaintainTime](~~473775~~)修改可维护时间段。', + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => 'Immediately', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付款，取值：'."\n" + .'* **true**：自动付款，默认值。'."\n" + .'* **false**：手动付款。取值为**false**时，您需要在实例到期前通过控制台手动续费，详情请参见[手动续费](~~26352~~)。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '变配类型，包年包月实例变配时需要传入本参数，取值：'."\n" + ."\n" + .'* **UPGRADE**：升级配置，默认值。'."\n" + .'* **DOWNGRADE**：降级配置。'."\n" + ."\n" + .'> * 包年包月实例降级配置时必须将该参数的值设置为**DOWNGRADE**。'."\n" + .'> * 如果变配的目标规格比现有规格的价格高，则为升级配置，反之为降级配置。例如，读写分离8G版（5只读节点）的价格比16G集群版的价格高，从后者变配到前者为升级配置。', + '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' => '适用于经典版实例升级的实例大版本，取值：**2.8**、**4.0**或**5.0**。'."\n" + .'> 升级版本时**InstanceClass**参数为必填，表示本接口仅支持在更新实例规格时升级版本。若您仅需升级实例版本，请调用[ModifyInstanceMajorVersion](~~473776~~)。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '5.0', + 'enum' => [ + '2.8', + '4.0', + '5.0', + '6.0', + ], + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'SourceBiz', + 'in' => 'query', + 'schema' => [ + 'description' => '调用来源，本参数仅用于内部维护使用，无需传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'SDK', + ], + ], + [ + 'name' => 'ShardCount', + 'in' => 'query', + 'schema' => [ + 'description' => '分片数，本参数仅适用于云原生版集群架构实例，您可以通过该参数实现自定义分片数量。'."\n" + ."\n" + .'> '."\n" + .'> - 如果要从云原生版集群架构实例变配到标准架构 ，ShardCount 需要显式传 1，并且规格传标准规格。'."\n" + .'> - 如果要从云原生版标准架构实例变配到集群架构，ShardCount 需要显式传大于1的值，并且规格传集群规格。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '4092', + 'minimum' => '1', + 'example' => '8', + ], + ], + [ + 'name' => 'ReplicaCount', + 'in' => 'query', + 'schema' => [ + 'description' => '主可用区的备节点数量，本参数仅适用于云原生版集群多副本实例，您可以通过该参数实现自定义备节点数量，取值：1~4。'."\n" + ."\n" + .'> 若实例为多可用区实例，您可以通过该参数与SlaveReplicaCount参数自定义主、备可用区的备节点数量。同时，该参数与SlaveReplicaCount参数的总和不能超过4。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'SlaveReplicaCount', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区的备节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'ReadOnlyCount', + 'in' => 'query', + 'schema' => [ + 'description' => '主可用区的只读节点数，本参数仅适用于创建云原生读写分离实例。'."\n" + .'* 若实例为标准架构，取值为0-9，0表示关闭读写分离，将实例切换为标准架构。'."\n" + .'* 若实例为集群架构，取值为1-4，表示每数据分片的只读节点数。'."\n" + .'> 若创建多可用区实例，您可以通过该参数和SlaveReadOnlyCount参数自定义主备可用区的只读节点数量。'."\n" + .'> * 若实例为标准架构，该参数与SlaveReadOnlyCount的总和不能大于9。'."\n" + .'> * 若实例为集群架构，该参数与SlaveReadOnlyCount的总和不能大于4。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9', + 'minimum' => '0', + 'example' => '5', + ], + ], + [ + 'name' => 'SlaveReadOnlyCount', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区的只读节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9', + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'ForceTrans', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启强制传输，取值：'."\n" + .'- **false**（默认）：在变配前，系统会检查实例当前的内核小版本，若内核版本过低则会报错，您需要升级内核小版本后重试。'."\n" + .'- **true**：跳过检查项，直接执行变配操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型，取值：'."\n" + .'* **MASTER_SLAVE**：高可用（双副本）'."\n" + .'* **STAND_ALONE**：单副本'."\n" + .'* **double**：双副本'."\n" + .'* **single**：单副本'."\n" + .'> 云原生版实例请选择**MASTER_SLAVE**或**STAND_ALONE**，经典版实例请选择**double**或**single**。', + 'type' => 'string', + 'required' => false, + 'example' => 'MASTER_SLAVE', + 'enum' => [ + 'MASTER_SLAVE', + 'STAND_ALONE', + 'double', + 'single', + ], + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型，取值为**essd_pl1**、**essd_pl2**、**essd_pl3**。'."\n" + .'> 当**InstanceType**取值为**tair_essd**时，且实例为Tair磁盘**ESSD**型时，才需要输入本参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'essd_pl1', + 'enum' => [ + 'essd_pl1', + 'essd_pl2', + 'essd_pl3', + ], + ], + ], + [ + 'name' => 'Storage', + 'in' => 'query', + 'schema' => [ + 'description' => '磁盘型实例的存储空间，不同的规格取值范围有所区别，详情请参见[磁盘型规格](~~2527111~~)。'."\n" + .'> 当**InstanceType**取值为**tair_essd**时，且创建Tair磁盘**ESSD**型时，才需要输入本参数。对于创建 Tair磁盘**SSD**型实例，容量字段按不同的规格定义为不同的固定值，无需指定该字段。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '20722623431****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '变更实例规格', + 'description' => '> 关于变更实例规格的执行流程、影响、功能限制及费用说明，请参见[变更实例配置](~~26353~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRegions' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例支持的所有地域及其对应可用区信息。', + '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' => '指定返回参数**LocalName**对应的值的语言，取值：'."\n" + .'* **zh-CN**：中文。'."\n" + .'* **en-US**：英文。'."\n" + ."\n" + .'> 默认值：**zh-CN**。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AD425AD3-CC7B-4EE2-A5CB-2F61BA73****', + ], + 'RegionIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'KVStoreRegion' => [ + 'description' => '**RegionIds**为对象', + 'type' => 'array', + 'items' => [ + 'description' => '**KVStoreRegion**为数组格式对象', + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => [ + 'description' => '地域的Endpoint。', + 'type' => 'string', + 'example' => 'r-kvstore.aliyuncs.com', + ], + 'LocalName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => '华东1（杭州）', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneIds' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'ZoneIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询可用的地域', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeZones' => [ + 'summary' => '查询指定地域下，云数据库 Tair（兼容 Redis）支持的可用区。若要查询当前可购买的可用区，请使用"DescribeAvailableResource"接口获取。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-huhehaote', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置返回后可用区名称的语言，取值：'."\n" + .'* **zh-CN**（默认）：中文。'."\n" + .'* **en-US**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'en-US', + 'default' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1D42F072-72FE-4DC4-BB8E-64B1D298****', + ], + 'Zones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'KVStoreZone' => [ + 'description' => '可用区的集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsRds' => [ + 'description' => '是否属于RDS管控，云数据库 Tair（兼容 Redis）实例中该参数的返回值固定为**true**。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ZoneId' => [ + 'description' => '该地域下的某可用区的ID。', + 'type' => 'string', + 'example' => 'cn-huhehaote-b', + ], + 'Disabled' => [ + 'description' => '当前可用区是否支持创建实例，返回值：'."\n" + .'* **true**：不支持。'."\n" + .'* **false**：支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SwitchNetwork' => [ + 'description' => '是否支持将实例从经典网络切换为专有网络，返回值：'."\n" + .'* **true**：支持。'."\n" + .'* **false**：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ZoneName' => [ + 'description' => '该地域下的某可用区的名称。', + 'type' => 'string', + 'example' => '呼和浩特 可用区B', + ], + 'RegionId' => [ + 'description' => '该地域的ID。', + 'type' => 'string', + 'example' => 'cn-huhehaote', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询支持的可用区', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAvailableResource' => [ + 'summary' => '查询指定可用区内可创建的实例规格。', + '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' => '地域ID，您可以调用[DescribeRegions](~~473763~~)查询。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID，您可以调用[DescribeZones](~~473764~~)查询。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'InstanceChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值：'."\n" + .'* **PrePaid**（默认）：包年包月。'."\n" + .'* **PostPaid**：按量付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrePaid', + 'default' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型，取值：'."\n" + .'* **BUY**（默认）：新购。'."\n" + .'* **UPGRADE**：升级实例规格配置。'."\n" + .'* **DOWNGRADE**：降级实例规格配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'BUY', + 'default' => 'BUY', + 'enum' => [ + 'BUY', + 'UPGRADE', + 'DOWNGRADE', + ], + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '引擎类型，取值：'."\n" + .'* **Redis**。'."\n" + .'* **Memcache**。', + 'type' => 'string', + 'required' => false, + 'example' => 'Redis', + 'enum' => [ + 'Redis', + 'Memcache', + 'redis', + 'memcache', + 'REDIS', + 'MEMCACHE', + ], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。您可以通过调用[ListResourceGroups](~~158855~~)接口获取资源组ID。'."\n" + .'> 您也可以通过控制台获取资源组ID，相关操作，请参见[查看资源组基本信息](~~151181~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4e******', + 'default' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + .'> 当**OrderType**取值为**UPGRADE**或**DOWNGRADE**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '返回值的语言，取值：'."\n" + .'* **zh-CN**：中文，默认值。'."\n" + .'* **en-US**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + 'default' => 'zh_CN', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类型，取值（默认值为 Local）：'."\n" + .'- **Local**：Redis开源版实例（经典版）或内存型（经典版）。'."\n" + .'- **Tair_rdb**：内存型（云原生版）。'."\n" + .'- **Tair_scm**：持久内存型。'."\n" + .'- **Tair_essd**：磁盘型。'."\n" + .'- **OnECS**：Redis开源版实例（云原生版）。'."\n" + .'> 该参数默认值为 Local，如果需要查云盘资源，需要传入所需云盘资源对应的产品类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'Local', + 'default' => 'Local', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据节点ID，可调用[DescribeLogicInstanceTopology](~~473786~~)获取。对于获取到的数据节点ID，需要去除井号（`#`）及其后面的内容，例如仅保留r-bp10noxlhcoim2****-db-0。'."\n" + .'> 传入本参数前，您还需要传入**InstanceId**参数，且要求实例为集群或读写分离架构。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****-db-0', + ], + ], + [ + 'name' => 'InstanceScene', + 'in' => 'query', + 'schema' => [ + 'description' => '产品系列，取值如下：'."\n" + .'- **professional**：标准版，支持单副本、主备、读写分离、集群四种架构，扩展性强。'."\n" + .' '."\n" + .'- **economical**：仅支持主备架构，具有价格优势，更多信息请参见[倚天版实例](~~2489678~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'professional', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '493B7308-D9C2-55F6-B042-0313BD63****', + ], + 'AvailableZones' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AvailableZone' => [ + 'description' => '可用区详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'ZoneName' => [ + 'description' => '可用区名称。', + 'type' => 'string', + 'example' => '杭州 可用区H', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SupportedEngines' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedEngine' => [ + 'description' => '引擎类型。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Engine' => [ + 'description' => '实例的引擎类型。', + 'type' => 'string', + 'example' => 'Redis', + ], + 'SupportedEditionTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedEditionType' => [ + 'description' => '实例类型。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EditionType' => [ + 'description' => '实例类型，返回值：'."\n" + .'* **Community**：Redis开源版。'."\n" + .'* **Enterprise**：Tair（企业版）。', + 'type' => 'string', + 'example' => 'Enterprise', + ], + 'SupportedSeriesTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedSeriesType' => [ + 'description' => '实例的系列。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SeriesType' => [ + 'description' => '已废弃字段，无需关注。根据返回的InstanceClass获取可用区内支持的规格信息即可。', + 'type' => 'string', + 'example' => 'enhanced_performance_type', + ], + 'SupportedEngineVersions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedEngineVersion' => [ + 'description' => '引擎版本（版本号）列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => '引擎版本。', + 'type' => 'string', + 'example' => '5.0', + ], + 'SupportedArchitectureTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedArchitectureType' => [ + 'description' => '架构类型。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Architecture' => [ + 'description' => '架构，返回值：'."\n" + .'* **standard**：经典版标准架构。'."\n" + .'* **non_cluster**：云原生版标准架构。'."\n" + .'* **cluster**：经典版集群架构/云原生版集群架构/云原生版读写分离架构。'."\n" + .'* **rwsplit**：经典版读写分离架构。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'SupportedShardNumbers' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedShardNumber' => [ + 'description' => '可用分片数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ShardNumber' => [ + 'description' => '分片数。仅本地盘（**Local**）支持返回本参数。', + 'type' => 'string', + 'example' => '8', + ], + 'SupportedNodeTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportedNodeType' => [ + 'description' => '节点类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点类型列表。', + 'type' => 'object', + 'properties' => [ + 'SupportedNodeType' => [ + 'description' => '节点类型，返回值：'."\n" + .'* **single**：单副本。'."\n" + .'* **double**：双副本。', + 'type' => 'string', + 'example' => 'double', + ], + 'AvailableResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AvailableResource' => [ + 'description' => '可用规格列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用规格列表。', + 'type' => 'object', + 'properties' => [ + 'InstanceClassRemark' => [ + 'description' => '实例规格描述。', + 'type' => 'string', + 'example' => '16G集群版（8节点）（QPS:1920000 Connections:240000）', + ], + 'Capacity' => [ + 'description' => '实例的内存容量，单位为MB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16384', + ], + 'InstanceClass' => [ + 'description' => '规格编码。可在帮助中心的搜索框中搜索规格编码，查看其对应的规格信息。', + 'type' => 'string', + 'example' => 'redis.amber.logic.sharding.2g.8db.0rodb.24proxy.multithread', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'IsMainSale' => [ + 'description' => '内部参数。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询某一可用区的资源列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TransformToPrePaid' => [ + 'summary' => '将按量付费的云数据库 Tair（兼容 Redis）实例转换为包年包月（预付费）实例。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '预付费时长，单位为月。取值：**1**~**9**、**12**、**24**、**36**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付款，取值：'."\n" + .'* **true**：自动付款。'."\n" + .'* **false**：手动付款（默认），您通过控制台对实例进行手动续费，详情请参见[手动续费](~~26352~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费。取值：'."\n" + ."\n" + .'* **true**：开启'."\n" + .'* **false**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费周期，单位为月，取值：**1**、**2**、**3**、**6**、**12**。'."\n" + ."\n" + .'> 当**AutoRenew**取值为**true**时，本参数必须传入。', + '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' => '实例付费方式转换为包年包月后的实例到期时间。', + 'type' => 'string', + 'example' => '2019-01-18T16:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '426F1356-B6EF-4DAD-A1C3-DE53B9DAF586', + ], + 'OrderId' => [ + 'description' => '订单ID。', + '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' => '将按量付费转换为包年包月', + 'description' => '该API对应的控制台操作请参见[转包年包月](~~54542~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'MigrateToOtherZone' => [ + 'summary' => '将云数据库 Tair（兼容 Redis）实例迁移到同地域内的其它可用区。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '要迁移到的目标主可用区ID，可调用[DescribeZones](~~473764~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-g', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机的ID 。'."\n" + ."\n" + .'> * vSwitch所在可用区须与ZoneId（目的可用区）一致； '."\n" + .'> * 如果实例的网络类型为VPC，则该参数为必选。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1e7clcw529l773d****', + 'default' => 'OpenApi', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '数据迁移后执行数据库切换的时间，取值： '."\n" + .'* **Immediately**：迁移完立即切换。'."\n" + .'* **MaintainTime**：在可维护时间段内切换。'."\n" + ."\n" + .'> 默认值：**Immediately**。', + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => '0', + 'enum' => [ + '0', + '1', + 'Immediately', + 'MaintainTime', + ], + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '要迁移到的目标备可用区ID，可调用[DescribeZones](~~473764~~)接口查询。'."\n" + .'> 传入本参数可以实现主备数据节点分布在不同的可用区，实现跨可用区容灾，可承受机房级别的故障。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'ReplicaCount', + 'in' => 'query', + 'schema' => [ + 'description' => '主可用区的备节点数（个）。'."\n" + .'> * **ReplicaCount**与**SlaveReplicaCount**参数仅适用于云原生版实例。在迁移至多可用区时，您可以通过本组参数调整实例主、备可用区的备节点分布。本接口不支持增、减节点数量，因此`ReplicaCount + SlaveReplicaCount`的总数需与迁移前保持一致。'."\n" + .'> * 在单可用区迁移至多可用区时，如果不填本组参数，则默认迁移1个备节点到备可用区，其余都在主可用区。'."\n" + .'> * 如果实例为集群架构，则上述参数分别表示单分片的（主、备可用区）备节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'SlaveReplicaCount', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区的备节点数（个）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'ReadOnlyCount', + 'in' => 'query', + 'schema' => [ + 'description' => '主可用区的只读节点数（个）。'."\n" + .'> * **ReadOnlyCount**与**SlaveReadOnlyCount**参数仅适用于云原生版、开启读写分离的实例。在迁移多可用区时，您可以通过本组参数调整实例主、备可用区的只读节点分布。本接口不支持增、减节点数量，因此`ReadOnlyCount + SlaveReadOnlyCount`的总数需与迁移前保持一致。'."\n" + .'> * 在单可用区迁移至多可用区时，如果不填本组参数，则默认迁移1个只读节点到备可用区，其余都在主可用区。'."\n" + .'> * 如果实例为集群架构，则上述参数分别表示单分片的（主、备可用区）只读节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'SlaveReadOnlyCount', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区的只读节点数（个）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9', + 'minimum' => '0', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '迁移实例至其他可用区', + 'description' => '执行本接口前需要先释放公网连接地址等，更多信息请参见[迁移可用区](~~106272~~)。'."\n" + ."\n" + .'> * 如果实例是从经典网络切换到专有网络的，并且保留了经典网络的连接地址，则需等到经典网络连接地址到期释放后才能执行可用区迁移。'."\n" + .'> * 迁移之后实例的连接地址不会改变，但VIP会发生变化，请在业务中使用连接地址连接实例而非其VIP地址。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateTairInstance' => [ + 'summary' => '创建云原生版的Tair（企业版）实例。', + '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' => '地域ID，可调用[DescribeRegions](~~473763~~)查询，使用此参数指定要创建实例的地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称，需满足下述要求：'."\n" + .'* 长度为2~80个字符。'."\n" + .'* 以大小写英文字母或中文开头，不支持空格和特殊字符：`@/:=”<>{[]}`。', + 'type' => 'string', + 'required' => false, + 'example' => 'apitest', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '实例密码，需满足下述要求：'."\n" + .'* 长度为8~32位。'."\n" + .'* 需包含大写字母、小写字母、特殊字符和数字中的至少三种，支持的特殊字符为`!@#$%^&*()_+-=`。', + 'type' => 'string', + 'required' => false, + 'example' => 'Pass!123456', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格，更多信息，请参见：'."\n" + .'- [内存型规格](~~2527112~~)。'."\n" + .'- [持久内存型规格](~~2527110~~)。'."\n" + .'- [磁盘型规格](~~2527111~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tair.scm.standard.4m.32d', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '主可用区ID，可调用[DescribeRegions](~~473763~~)查询，使用此参数指定要创建实例的可用区。'."\n" + .'> 您也可以再传入SecondaryZoneId参数指定备可用区，主备节点将分别部署在指定的主可用区和备可用区，实现同城双中心主备架构。例如指定ZoneId参数为"cn-hangzhou-h"，指定SecondaryZoneId参数为"cn-hangzhou-g"。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou-h', + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区ID，可调用[DescribeRegions](~~473763~~)查询。'."\n" + ."\n" + .'> 本参数和ZoneId参数传入的值不能相同，且不可传入多可用区对应的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值：'."\n" + .'- **PrePaid**（默认）：预付费，即包年包月。'."\n" + .'- **PostPaid**：按量付费。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PostPaid' => 'PostPaid', + 'PrePaid' => 'PrePaid', + ], + 'example' => 'PrePaid', + 'default' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID，可调用专有网络VPC的[DescribeVpcs](~~35739~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '该专有网络下的虚拟交换机ID，可调用专有网络VPC的[DescribeVpcs](~~35739~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '付费周期，单位为月，取值：**1**~**9**、**12**、**24**、**36**、**60** 。'."\n" + .'> 当**ChargeType**取值为**PrePaid**时，本参数必须传入。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '活动ID、业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '000000000', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠码。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'default' => 'default', + ], + ], + [ + 'name' => 'SrcDBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '如需基于某个实例的备份集创建新实例，请先在此参数中指定源实例ID。'."\n" + .'> 然后通过**BackupId**、**ClusterBackupId**（云原生集群架构建议使用ClusterBackupId）或**RestoreTime**参数指定需要使用的备份集或指定时间点，本参数需要与上述3个中的任意一个参数组合使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '您可在此参数中指定源实例的备份集ID，系统将使用该备份集中保存的数据创建新实例。通过调用[DescribeBackups](~~473823~~)可查询BackupId。如果源实例是集群实例，则此处需要填写源实例各个分片的备份集id，并且通过逗号隔开，例如"10**,11**,15**"。'."\n" + .'> 若您的实例是云原生架构实例，并且是集群实例，则建议您使用[DescribeClusterBackupList](~~2679168~~)查询出集群备份集id，例如"cb-xx"，然后填入ClusterBackupId请求参数来达到克隆集群实例的目的，免去您输入各个分片备份集id的烦恼。', + 'type' => 'string', + 'required' => false, + 'example' => '2158****20', + ], + ], + [ + 'name' => 'ClusterBackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '部分新集群架构支持集群备份集ID，您可以通过[DescribeClusterBackupList](~~2679168~~)接口获取。'."\n" + .'* 若支持，可输入指定的集群备份集ID即可，无需再填写**BackupId**参数。'."\n" + .'* 若不支持，请在BackupId参数中填写为原实例各个分片下的备份集ID，通过逗号隔开，例如"2158\\*\\*\\*\\*20,2158\\*\\*\\*\\*22"等。', + 'type' => 'string', + 'required' => false, + 'example' => 'cb-hyxdof5x9kqb****', + ], + ], + [ + 'name' => 'RecoverConfigMode', + 'in' => 'query', + 'schema' => [ + 'description' => '使用指定备份集创建实例时，是否从原备份集中恢复账号（account）、内核参数（config）、白名单（whitelist）信息。例如需恢复账号信息，则取值为account。'."\n" + ."\n" + .'默认为空，表示不从原备份集中恢复账号、内核参数、白名单信息。'."\n" + .'> 本参数仅适用于云原生版实例，且需要原备份集中已保存了账号、内核参数、白名单信息。您可以通过[DescribeBackups](~~473823~~)接口查询指定备份集中的RecoverConfigMode参数是否包含上述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'whitelist,config,account', + ], + ], + [ + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '指定实例的内网IP地址。'."\n" + ."\n" + .'> 该地址需在实例所属交换机的网段内，您可以调用专有网络VPC的[DescribeVSwitches](~~35748~~)获取网段信息。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.88.***', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用代金券，取值：'."\n" + .'* **true**：使用代金券。'."\n" + .'* **false**（默认）：不使用代金券。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费，取值：'."\n" + .'* **true**：开启。'."\n" + .'* **false**（默认）：不开启。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费周期，单位为月，取值：**1**、**2**、**3**、**6**、**12**。'."\n" + .'> 当**AutoRenew**取值为**true**时，本参数必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标资源组ID。'."\n" + ."\n" + .'> * 您可以通过调用[ListResourceGroups](~~158855~~)接口或通过控制台获取资源组ID列表。相关操作，请参见[查看资源组基本信息](~~151181~~)。'."\n" + .'> * 修改实例所属的资源组之前，您可以调用[ListResources](~~158866~~)接口查看实例现在所属的资源组。', + 'type' => 'string', + 'required' => false, + 'maximum' => '4096', + 'minimum' => '1', + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '自动支付，取值固定为**true**。'."\n" + ."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + 'enum' => [ + 'true', + ], + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型，取值为**essd_pl1**、**essd_pl2**、**essd_pl3**。'."\n" + .'> 当**InstanceType**取值为**tair_essd**时，且创建ESSD型时，才需要输入本参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'essd_pl1', + 'enum' => [ + 'essd_pl0', + 'essd_pl1', + 'essd_pl2', + 'essd_pl3', + ], + ], + ], + [ + 'name' => 'Storage', + 'in' => 'query', + 'schema' => [ + 'description' => '磁盘型实例的存储空间，不同的规格取值范围有所区别，详情请参见[磁盘型规格](~~2527111~~)。'."\n" + .'> 当**InstanceType**取值为**tair_essd**时，且创建ESSD型时，才需要输入本参数。对于创建 Tair 磁盘**SSD**型实例，容量字段按不同的规格定义为不同的固定值，无需指定该字段。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'ShardType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型，取值：'."\n" + .'- **MASTER_SLAVE**（默认）：高可用，采用主备架构，可保障可用性。'."\n" + .'- **STAND_ALONE**：单副本，采用单节点架构。在节点故障后，数据会丢失，系统会自动拉起新的空实例。仅在**单可用区**时支持，且不支持创建集群与读写分离架构。', + 'type' => 'string', + 'required' => false, + 'example' => 'MASTER_SLAVE', + 'default' => 'MASTER_SLAVE', + 'enum' => [ + 'STAND_ALONE', + 'MASTER_SLAVE', + ], + ], + ], + [ + 'name' => 'ShardCount', + 'in' => 'query', + 'schema' => [ + 'description' => '实例中的数据节点个数，取值：'."\n" + .'* **1**：默认值，即表示创建的实例为[标准架构](~~52228~~)，仅拥有1个数据节点。'."\n" + .'* **2**~**32**：传入该范围的值，即表示创建的实例为[集群架构](~~52228~~)，拥有指定数量的数据节点。'."\n" + ."\n" + .'> 当**InstanceType**取值为**tair_rdb**或**tair_scm**时，本参数才可以传入**2**~**32**，即只有内存型和持久内存型支持集群架构。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '128', + 'minimum' => '1', + 'example' => '2', + 'default' => '1', + ], + ], + [ + 'name' => 'ReplicaCount', + 'in' => 'query', + 'schema' => [ + 'description' => '主可用区的备节点数，本参数仅适用于创建云原生版集群多副本实例，您可以通过该参数实现自定义备节点数量，取值：1~4。'."\n" + .'> 若创建多可用区实例，您可以通过该参数与SlaveReplicaCount参数自定义主、备可用区的备节点数量。同时，该参数与SlaveReplicaCount参数的总和不能超过4。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'SlaveReplicaCount', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区的备节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'ReadOnlyCount', + 'in' => 'query', + 'schema' => [ + 'description' => '主可用区的只读节点数，本参数仅适用于创建云原生读写分离实例。'."\n" + .'* 若实例为标准架构，取值为1~9。'."\n" + .'* 若实例为集群架构，取值为1-4，表示每数据分片的只读节点数。'."\n" + .'> 若创建多可用区实例，您可以通过该参数和SlaveReadOnlyCount参数自定义主备可用区的只读节点数量。'."\n" + .'> * 若实例为标准架构，该参数与SlaveReadOnlyCount的总和不能大于9。'."\n" + .'> * 若实例为集群架构，该参数与SlaveReadOnlyCount的总和不能大于4。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '5', + 'minimum' => '1', + 'example' => '5', + ], + ], + [ + 'name' => 'SlaveReadOnlyCount', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区的只读节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库版本，默认取值：**1.0**，不同 Tair 产品类型传参规则：'."\n" + .'- Tair_rdb: Tair 内存型兼容Redis 5.0、Redis 6.0和Redis 7.0协议，传**5.0**、**6.0**或**7.0**。'."\n" + .'- Tair_scm: Tair 持久内存兼容Redis 6.0协议，传**1.0**。'."\n" + .'- Tair_essd: Tair 磁盘（ESSD/SSD）兼容Redis 6.0协议。 创建ESSD型请传入**1.0**、创建SSD型请传入**2.0**。', + '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' => '存储介质，取值：'."\n" + .'* **tair_rdb**：内存型。'."\n" + .'* **tair_scm**：持久内存型。'."\n" + .'* **tair_essd**：磁盘型。', + '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' => '是否将本次新建的实例作为分布式实例中的子实例，通过该方式可创建分布实例。'."\n" + .'* 若希望新建的实例作为第一个子实例，请输入**true**。'."\n" + .'* 若希望新建的实例作为第二、三个子实例，请输入分布式实例 ID，例如gr-bp14rkqrhac****。'."\n" + .'* 不作为分布式实例，您无需输入任何值。'."\n" + .'> 若希望作为分布式实例，本次新建的实例需为Tair内存型。', + 'type' => 'string', + 'required' => false, + 'example' => 'gr-bp14rkqrhac****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例的标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键，与Tag Value组成标签的键值对。'."\n" + .'> 单次最多支持传入5组标签的键值对。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1_test', + ], + 'Value' => [ + 'description' => '标签的值。'."\n" + .'> **N**表示传入第几个标签的值。例如**Tag.1.Value**表示传入第一个标签的值；**Tag.2.Value**表示传入第二个标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1_test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对本次创建实例的操作执行预检查，取值：'."\n" + .'* **true**：执行预检查操作，不创建实例。检查项目包含请求参数、请求格式、业务限制和库存。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'* **false**（默认）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '实例的服务端口，取值范围：1~65535，默认值为6379。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '65535', + 'minimum' => '1024', + 'exclusiveMinimum' => false, + 'example' => '6379', + 'default' => '6379', + ], + ], + [ + 'name' => 'GlobalSecurityGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的全局IP白名单模板，多个IP白名单模板请用英文逗号（,）分隔，不可重复。', + 'type' => 'string', + 'required' => false, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'ParamGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模板ID，根据新创建的参数模板参数创建实例，不可重复。', + 'type' => 'string', + 'required' => false, + 'example' => 'g-50npzjcqb1ua6q6j****', + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => '若源实例已开启数据闪回，您可在此参数中指定源实例备份保留周期内的任意时间点，系统将使用源实例在该时间点的备份数据创建新实例。格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-07-06T07:25:57Z', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '连接地址的前缀，需由小写英文字母与数字组成，以小写字母开头，长度为8~40个字符。'."\n" + ."\n" + .'> '."\n" + .'> 连接地址格式为：<前缀-实例ID>.redis.rds.aliyuncs.com。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'QPS' => [ + 'description' => '每秒处理的最大读写操作数，单位为次/秒，此处为当前实例规格的理论值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'ConnectionDomain' => [ + 'description' => '实例的内网连接地址。', + 'type' => 'string', + 'example' => 'r-bp13ac3d047b****.tairpena.rds.aliyuncs.com', + ], + 'ChargeType' => [ + 'description' => '实例的付费类型，返回值：'."\n" + .'- **PrePaid**：预付费。'."\n" + .'- **PostPaid**：按量付费。', + 'type' => 'string', + 'example' => 'PrePaid', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp13ac3d047b****', + ], + 'Port' => [ + 'description' => '实例的端口号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6379', + ], + 'Config' => [ + 'description' => '实例的详细配置，格式为JSON字符串。关于各参数的详细解释，请参见[参数配置说明](~~43885~~)。', + 'type' => 'string', + 'example' => '{\\"EvictionPolicy\\":\\"volatile-lru\\",\\"hash-max-ziplist-entries\\":512,\\"zset-max-ziplist-entries\\":128,\\"list-max-ziplist-entries\\":512,\\"list-max-ziplist-value\\":64,\\"zset-max-ziplist-value\\":64,\\"set-max-intset-entries\\":512,\\"hash-max-ziplist-value\\":64}', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '12123216-4B00-4378-BE4B-08005BFC****', + ], + 'Bandwidth' => [ + 'description' => '实例的最大带宽，单位：MB/s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '96', + ], + 'Connections' => [ + 'description' => '实例的最大连接数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'InstanceName' => [ + 'description' => '实例名称。'."\n" + .'> 当传入了请求参数**InstanceName**时，本参数才会返回。', + 'type' => 'string', + 'example' => 'redistest', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'InstanceStatus' => [ + 'description' => '实例当前的状态，返回值固定为**Creating**（创建中）。', + 'type' => 'string', + 'example' => 'Creating', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '10****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + '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' => '创建Tair（企业版）实例', + 'description' => '选型参考资料，请参见[云数据库 Tair（兼容 Redis）选型必读](~~223808~~)。'."\n" + ."\n" + .'请确保在使用该接口前，已充分了解云数据库 Tair（兼容 Redis）产品的收费方式和[价格](~~54532~~)。'."\n" + ."\n" + .'> * 关于控制台的操作方法，请参见[创建Tair实例](~~26351~~)。'."\n" + .'> * 如需创建其他类型的实例，例如开源版或[Tair内存型](~~126164~~)经典版实例，您可以调用[CreateInstance](~~473757~~)接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateInstances' => [ + 'summary' => '批量创建云数据库 Tair（兼容 Redis）经典版实例。', + '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' => '新实例的配置信息，格式为JSON，详细说明请参见Instances参数补充说明。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{'."\n" + .' "RegionId": "cn-hangzhou",'."\n" + .' "izNo": "cn-hangzhou-b",'."\n" + .' "quantity": 1,'."\n" + .' "instanceType": "Redis",'."\n" + .' "instanceClass": "redis.logic.sharding.1g.2db.0rodb.4proxy.default",'."\n" + .' "EngineVersion": "5.0", '."\n" + .' "ChargeType":"PrePaid",'."\n" + .' "Period":"1",'."\n" + .' "networkType": "VPC" ,'."\n" + .' "vpcId": "vpc-2zex6u1nu32k3ux35oxxx", '."\n" + .' "vSwitchId": "vsw-2zesk464e647104kw3xxx"'."\n" + .'}]', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费，取值：'."\n" + ."\n" + .'* **true**：自动付费，默认值。'."\n" + .'* **false**：手动付费。您需要在控制台的顶部菜单栏，单击**费用** > **续费管理**，然后单击左侧导航栏的**订单管理** > **我的订单**，找到目标订单进行支付。'."\n" + ."\n" + .'> **Instances**参数中，**ChargeType**取值为**PrePaid**时，本参数才可用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '业务扩展信息。', + 'type' => 'string', + 'required' => false, + 'example' => '000000000', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠码，默认值为：`youhuiquan_promotion_option_id_for_blank`。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'default' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '实例兼容Redis的版本，取值：**4.0**、**5.0**。'."\n" + .'> 默认值为**5.0**。', + 'type' => 'string', + 'required' => false, + 'example' => '5.0', + 'default' => '2.8', + 'enum' => [ + '2.8', + '4.0', + '5.0', + ], + ], + ], + [ + 'name' => 'RebuildInstance', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要从回收站中重建恢复源实例，取值：'."\n" + .'* **true**：需要。'."\n" + .'* **false**：不需要，默认值。'."\n" + ."\n" + .'> **Instances**参数中设置了**SrcDBInstanceId**参数时，本参数才可用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费，取值：'."\n" + .'* **true**：开启。'."\n" + .'* **false**：不开启，默认值。'."\n" + ."\n" + .'> **Instances**参数中，**ChargeType**取值为**PrePaid**时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-resourcegroupid1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '20905403119****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****', + ], + 'InstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceId' => [ + 'description' => '本次创建的实例ID的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + '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' => '批量创建实例', + 'description' => '请确保在使用该接口前，已充分了解云数据库 Tair（兼容 Redis）产品的收费方式和[价格](~~54532~~)。'."\n" + .'> 本接口仅支持创建经典版实例。'."\n" + .'推荐您使用创建单个实例的API接口：'."\n" + .'> - [CreateInstance](~~473757~~)：创建Redis开源版实例、Tair内存型经典版实例。'."\n" + .'> - [CreateTairInstance](~~473770~~)：创建Tair云原生版实例（含内存型、持久内存、磁盘型）。', + 'requestParamsDescription' => '### Instances参数补充说明'."\n" + .' '."\n" + .''."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .''."\n" + .''."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .''."\n" + .'
名称类型是否必选示例值描述
RegionIdString是cn-hangzhou地域ID，可调用DescribeRegions查询，使用此参数指定要创建实例的地域。
IzNoString是cn-hangzhou-b主可用区ID，可调用DescribeRegions查询，使用此参数指定要创建实例的可用区。
QuantityInteger否1要创建的实例数量，取值范围：1~300，默认值为1。
InstanceTypeString否Redis实例类型，取值：
  • Redis（默认）：云数据库 Tair（兼容 Redis）实例。
  • Memcache：Memcache实例。
InstanceClassString否redis.master.small.default实例的规格，例如redis.master.small.default为社区版（经典版）标准架构双副本1 GB实例，详细信息请参见规格查询导航。
说明 本参数和Capacity两者中必须传入一项。
CapacityLong否16384实例的存储容量，单位为MB，详细信息请参见规格查询导航。
说明 本参数和InstanceClass两者中必须传入一项。
EngineVersionString否5.0实例兼容Redis的版本，取值：
  • 5.0（默认）
  • 4.0
ChargeTypeString否PrePaid付费类型，取值：
  • PrePaid：包年包月（预付费）。
  • PostPaid（默认）：按量付费（后付费）。
PeriodLong否12付费周期，单位为月，取值：1~9、12、24、36、60。
说明 当ChargeType参数取值为PrePaid时，本参数才可用且必须传入。
AutoRenewString否true是否开启自动续费，取值：
  • true：开启。
  • false（默认）：不开启。
说明 当ChargeType参数取值为PrePaid时，本参数才可用。
InstanceNameString否apitest实例的名称，需满足下述要求：
  • 以大小写字母或中文开头，长度为2~80个字符。
  • 不支持空格和特殊字符：@/:=”<>{[]}
PasswordString否Pass!123456实例的密码，需满足下述要求：
  • 长度为8~32位。
  • 需包含大写字母、小写字母、特殊字符和数字中的至少三种。
  • 支持的特殊字符为：!@#$%^&*()_+-=
NetworkTypeString否VPC网络类型，取值：VPC（当前仅支持创建 VPC 网络实例）：专有网络VPC。
VpcIdString否vpc-bp1nme44gek34slfc****专有网络ID，可调用专有网络VPC的DescribeVpcs获取。
VSwitchIdString否vsw-bp1e7clcw529l773d****该专有网络下的虚拟交换机ID，可调用专有网络VPC的DescribeVpcs获取。
NodeTypeString否MASTER_SLAVE节点类型，取值：
  • STAND_ALONE：单副本。
  • MASTER_SLAVE（默认）：高可用（双副本）。
SrcDBInstanceIdString否r-bp1zxszhcgatnx****源实例ID，可调用DescribeInstances获取。
说明 当您需要基于该实例的备份数据创建新实例时，您才需要传入本参数。
BackupIdString否111111111备份集ID，可通过调用DescribeBackups查询。
说明 如需基于某个实例的备份数据创建新实例，在传入SrcDBInstanceId参数指定了源实例后，您还需要在本参数中指定源实例的备份集ID，系统将基于该备份集的数据创建新的实例。
RebuildInstanceString否false是否需要从回收站中重建恢复源实例，取值：
  • true：需要。
  • false（默认）：不需要。
说明 如果传入了本参数，则必须传入SrcDBInstanceId参数。
'."\n" + ."\n" + .'### Instances参数请求示例'."\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' => '调整云数据库 Tair（兼容 Redis）实例的带宽，当前仅支持按量付费的计费方式，您仅需填写InstanceId、NodeId（可选）、Bandwidth、ChargeType参数即可。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠券编号。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'default' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付款，取值：'."\n" + ."\n" + .'* **true**：默认值，自动付款，请确保账号有足够的余额。'."\n" + .'* **false**：手动付款。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据分片ID，您可以调用[DescribeLogicInstanceTopology](~~473786~~)获取，传入多个时使用英文逗号（,）分隔；您也可以传入**All**（即表示所有数据分片）。'."\n" + .'> 当实例为[集群架构](~~52228~~)或[读写分离架构](~~62870~~)时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'r-bp1zxszhcgatnx****-db-0', + 'default' => '', + ], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '要增加的带宽，单位为MB/s。取值为大于等于**0**的整数 ，最大可传入该实例（或单分片）规格默认带宽的6倍，但增加的上限为192MB/s。例如实例默认带宽为10 MB/s，可增加的范围为**0**~**60**。'."\n" + ."\n" + .'> * 您可以调用[DescribeRoleZoneInfo](~~473782~~)接口，通过返回参数**DefaultBandWidth**获取默认最大带宽。更多关于实例规格的信息，请参见[实例规格查询导航](~~26350~~)。'."\n" + .'> * 如果请求参数**NodeId**传入了多个数据分片ID，本参数传入的带宽值需和数据分片ID的顺序对应，多个带宽值之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'OrderTimeLength', + 'in' => 'query', + 'schema' => [ + 'description' => '购买的时长，单位为天，取值：**1**、**2**、**3**、**7**、**14**、**30**、**60**、**90**、**180**、**365**、**730**、**1095**、**1825**。'."\n" + .'> 如果需要继续使用购买的带宽，您需要在带宽到期前调用[RenewAdditionalBandwidth](~~473804~~)接口及时续费。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '30', + 'default' => '1', + ], + ], + [ + 'name' => 'SourceBiz', + 'in' => 'query', + 'schema' => [ + 'description' => '调用来源，本参数仅用于内部维护使用，无需传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'SDK', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费，取值：'."\n" + .'* **true**：开启。'."\n" + .'* **false**：不开启，默认值。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费周期，单位为月，取值：**1**、**2**、**3**、**4**、**5**、**6**、**7**、**8**、**9**、**12**、**24**、**36**、**60**。'."\n" + ."\n" + .'> * 当**AutoRenew**参数取值为**true**时，本参数才可用且必须传入。'."\n" + .'> * 该参数设置后暂不支持通过API查询，您可以在控制台的顶部菜单栏，单击**费用** > **续费管理**，然后在**实例ID**文本框中输入实例ID加`-bw`后缀（例如r-bp1zxszhcgatnx****-bw）来查询。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '额外增加带宽的付费类型，取值：'."\n" + .'* **PrePaid**：预付费，即包年包月。'."\n" + .'* **PostPaid**：按量付费，当前仅支持该方式。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'PrePaid', + 'enum' => [ + 'PostPaid', + 'PrePaid', + ], + ], + ], + [ + 'name' => 'BandWidthBurst', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2084452111111', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '调整实例带宽', + 'description' => '若您在调用本接口的同时，开启了实例带宽弹性伸缩功能，则实例会优先使用带宽弹性伸缩功能，且在带宽弹性回缩时，将回缩至实例规格的默认带宽。更多关于该功能限制、费用说明及常见问题，请参见[调整实例带宽](~~102588~~)。'."\n" + ."\n" + .'> 调用本接口前，您可以调用[DescribeRoleZoneInfo](~~473782~~)查询实例中各数据节点的当前带宽。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyInstanceAttribute' => [ + 'summary' => '修改云数据库 Tair（兼容 Redis）实例的部分信息，包括实例密码、名称等。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '新的实例名称。名称为2~80个字符，以大小写英文字母或中文开头，不支持空格及特殊字符：`@/:=”<>{[]}`。', + 'type' => 'string', + 'required' => false, + 'example' => 'newinstancename', + ], + ], + [ + 'name' => 'NewPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '新的默认账号密码，默认账号为以实例ID命名的账号（例如r-bp10noxlhcoim2****）。'."\n" + .'> 长度为8~32位，需包含大写字母、小写字母、数字、特殊字符（支持`!@#$%^&*()_+-=`）中至少三种。', + 'type' => 'string', + 'required' => false, + 'example' => 'uW8+nsrp', + ], + ], + [ + 'name' => 'InstanceReleaseProtection', + 'in' => 'query', + 'schema' => [ + 'description' => '[实例释放保护状态](~~165005~~)，取值：'."\n" + .'* **true**：开启。'."\n" + .'* **false**：关闭。'."\n" + ."\n" + .'> 仅按量付费实例支持本参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改实例部分信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyResourceGroup' => [ + 'summary' => '修改云数据库 Tair（兼容 Redis）实例所属的资源组。', + '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' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标资源组ID。'."\n" + ."\n" + .'> * 您可以通过调用[ListResourceGroups](~~158855~~)接口或通过控制台获取资源组ID列表。相关操作，请参见[查看资源组基本信息](~~151181~~)。'."\n" + .'> * 修改实例所属的资源组之前，您可以调用[ListResources](~~158866~~)接口查看实例现在所属的资源组。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改实例所属资源组', + 'description' => '您也可以在[资源管理](https://resourcemanager.console.aliyun.com/resource-center)控制台执行本操作，具体操作请参见[跨资源组转移资源](~~94487~~)。'."\n" + .'> 资源组（Resource Group）是在阿里云账号下进行资源分组管理的一种机制，资源组能够帮助您解决单个阿里云账号内的资源分组和授权管理的复杂性问题。更多信息，请参见[什么是资源管理](~~94475~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyInstanceMaintainTime' => [ + 'summary' => '修改云数据库 Tair（兼容 Redis）实例的可维护时段，阿里云将在您设定的可维护时段内对实例进行例行维护。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '可维护时段的开始时间，格式为HH:mmZ（UTC时间）。例如，需要在北京时间凌晨1点开始，应设置为`17:00Z`。调用该接口后，您可以到控制台查看实际时间，详情请参见[设置可维护时段](~~55252~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '03:00Z', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '可维护时段的结束时间，格式为HH:mmZ（UTC时间）。例如，需要在北京时间凌晨2点结束，应设置为`18:00Z`。'."\n" + ."\n" + .'> 开始时间和结束时间的间隔不能低于1小时。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '04:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改可维护时段', + 'description' => '该API对应的控制台操作请参见[设置可维护时段](~~55252~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyInstanceMajorVersion' => [ + 'summary' => '升级云数据库 Tair（兼容 Redis）实例的大版本。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'MajorVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '升级实例版本。'."\n" + .'- 云原生版实例可升级的大版本取值：6.0或7.0。'."\n" + .'- 经典版实例可升级的大版本取值：4.0（不推荐）或5.0。'."\n" + .'> 仅支持升级至相同部署模式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5.0', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '升级执行时间，取值：'."\n" + .'* **Immediately**：立即执行，默认值。'."\n" + .'* **MaintainTime**：在可维护时间段执行。'."\n" + ."\n" + .'> 您可以调用[ModifyInstanceMaintainTime](~~473775~~)修改实例的可维护时间段。', + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => '0', + 'enum' => [ + '0', + '1', + 'Immediately', + 'MaintainTime', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '升级大版本', + 'description' => '关于该API操作的注意事项和升级影响，请参见[升级大版本](~~101764~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyInstanceMinorVersion' => [ + 'summary' => '升级云数据库 Tair（兼容 Redis）实例的小版本。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Minorversion', + 'in' => 'query', + 'schema' => [ + 'description' => '要升级到的小版本，默认值：**latest_version**，即最新版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'latest_version', + 'default' => 'latest_version', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '升级执行时间，取值：'."\n" + .'* **Immediately**：立即执行，默认值。'."\n" + .'* **MaintainTime**：在可维护时间段执行。'."\n" + ."\n" + .'> 您可以调用[ModifyInstanceMaintainTime](~~473775~~)修改实例的可维护时间段。', + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => '0', + 'enum' => [ + '0', + '1', + 'Immediately', + 'MaintainTime', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '升级小版本', + 'description' => '不同的架构在升级时所采取的流程有所区别，详细介绍，请参见[小版本升级原理](~~56450~~)。'."\n" + ."\n" + .'> * 调用本接口前，您可以调用[DescribeEngineVersion](~~473781~~)查询实例当前的小版本。'."\n" + .'> * 在实例切换或主备切换阶段，实例将存在60秒以内的只读状态（等待数据完全同步），同时会发生秒级的连接闪断，请在业务低峰期进行升级，并确保应用程序具备重连机制。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBInstanceAutoUpgrade' => [ + 'summary' => '修改实例的小版本自动升级开关。', + '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' => '实例ID，可调用DescribeDBInstances获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '小版本自动升级开关，取值：'."\n" + .'* **1**：开启。'."\n" + .'* **0**：关闭。', + '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。', + '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' => '修改小版本自动升级开关', + ], + 'DescribeInstancesOverview' => [ + 'summary' => '查询一个或多个云数据库 Tair（兼容 Redis）实例的信息概览。', + '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' => '实例所属的地域ID，可调用[DescribeRegions](~~473763~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的实例ID。'."\n" + .'> 默认查询该账号下所有实例。如需传入多个实例ID时，使用英文逗号（,）分隔实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'InstanceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '实例状态，取值：'."\n" + .'* **Normal**：运行中。'."\n" + .'* **Creating**：创建中。'."\n" + .'* **Changing**：修改中。'."\n" + .'* **Inactive**：被禁用。'."\n" + .'* **Flushing**：清除中。'."\n" + .'* **Released**：已释放。'."\n" + .'* **Transforming**：转换中。'."\n" + .'* **Migrating**：迁移中。'."\n" + .'* **BackupRecovering**：备份恢复中。'."\n" + .'* **MinorVersionUpgrading**：小版本升级中。'."\n" + .'* **NetworkModifying**：网络变更中。'."\n" + .'* **SSLModifying**：SSL变更中。'."\n" + .'* **MajorVersionUpgrading**：大版本升级中，可正常访问。'."\n" + ."\n" + .'> 更多实例状态及详细信息，请参见[实例状态与影响](~~200740~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值：'."\n" + .'* **PrePaid**：预付费，即包年包月。'."\n" + .'* **PostPaid**：后付费，即按量付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + 'dhgpay', + ], + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '网络类型，取值：'."\n" + .'* **CLASSIC**：经典网络。'."\n" + .'* **VPC**：专有网络。', + 'type' => 'string', + 'required' => false, + 'example' => 'CLASSIC', + 'enum' => [ + 'CLASSIC', + 'VPC', + ], + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '实例兼容Redis的版本，返回值：**2.8**、**4.0**、**5.0**、**6.0**或**7.0**。', + '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' => '6.0', + 'enum' => [ + '1.0', + '2.8', + '4.0', + '5.0', + '6.0', + '7.0', + ], + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格，请参见[实例规格表](~~107984~~)。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'redis.master.small.default', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型，取值：'."\n" + .'* **Tair**。'."\n" + .'* **Redis**。'."\n" + .'* **Memcache**。', + 'type' => 'string', + 'required' => false, + 'example' => 'Redis', + 'default' => 'Redis', + 'enum' => [ + 'Redis', + 'Memcache', + 'tair_essd', + 'tair_scm', + 'tair_rdb', + 'Tair', + ], + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '基于实例ID或者实例备注模糊搜索时使用的关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'apitest', + ], + ], + [ + 'name' => 'ArchitectureType', + 'in' => 'query', + 'schema' => [ + 'description' => '架构类型，取值：'."\n" + .'* **cluster**：集群版。'."\n" + .'* **standard**：标准版。'."\n" + .'* **rwsplit**：读写分离版。', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + .'> 您可以通过调用[ListResourceGroups](~~158855~~)接口或通过控制台获取资源组ID列表。相关操作，请参见[查看资源组基本信息](~~151181~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'EditionType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型，取值：'."\n" + .'* **Community**：开源版。'."\n" + .'* **Enterprise**：企业版。', + 'type' => 'string', + 'required' => false, + 'example' => 'Enterprise', + 'enum' => [ + 'Enterprise', + 'Community', + ], + ], + ], + [ + 'name' => 'PrivateIp', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.49.***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1E83311F-0EE4-4922-A3BF-730B312B****', + ], + 'TotalCount' => [ + 'description' => '实例总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Instances' => [ + 'description' => '由Instance（实例）组成的数组。', + 'type' => 'array', + 'items' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + 'PrivateIp' => [ + 'description' => '专有网络IP地址，IP地址可能会发生变化，请通过ConnectionDomain（内网连接地址）进行连接。'."\n" + .'> - 实例的网络类型为经典网络时，不会返回本参数。'."\n" + .'> - 云原生版实例不会返回该参数。', + 'type' => 'string', + 'example' => '172.16.49.***', + ], + 'Capacity' => [ + 'description' => '实例容量， 单位：MB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4096', + ], + 'CreateTime' => [ + 'description' => '实例的创建时间。', + 'type' => 'string', + 'example' => '2018-11-07T08:49:00Z', + ], + 'ConnectionDomain' => [ + 'description' => '实例的内网连接地址。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', + ], + 'ChargeType' => [ + 'description' => '付费类型，取值：'."\n" + .'* **PrePaid**：预付费，即包年包月。'."\n" + .'* **PostPaid**：后付费，即按量付费。', + 'type' => 'string', + 'example' => 'PrePaid', + ], + 'ArchitectureType' => [ + 'description' => '架构类型，取值：'."\n" + .'* **cluster**：集群版。'."\n" + .'* **standard**：标准版。'."\n" + .'* **rwsplit**：读写分离版。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'NetworkType' => [ + 'description' => '网络类型，取值：'."\n" + .'* **CLASSIC**：经典网络。'."\n" + .'* **VPC**：专有网络。', + 'type' => 'string', + 'example' => 'CLASSIC', + ], + 'EngineVersion' => [ + 'description' => '实例兼容的Redis版本，返回值：**2.8**、**4.0**、**5.0**、**6.0**或**7.0**。', + 'type' => 'string', + 'example' => '6.0', + ], + 'InstanceName' => [ + 'description' => '实例的名称。', + 'type' => 'string', + 'example' => 'apitest', + ], + 'GlobalInstanceId' => [ + 'description' => '分布式实例ID。'."\n" + .'> 当实例为分布式实例中的子实例时，才会返回该参数。', + 'type' => 'string', + 'example' => 'gr-bp14rkqrhac****', + ], + 'InstanceClass' => [ + 'description' => '实例的规格。', + 'type' => 'string', + 'example' => 'redis.logic.sharding.2g.2db.0rodb.4proxy.default', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'InstanceType' => [ + 'description' => '实例类型，取值：'."\n" + .'* **Tair**：Tair（企业版）'."\n" + .'* **Redis**：Redis开源版'."\n" + .'* **Memcache**', + 'type' => 'string', + 'example' => 'Redis', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'EndTime' => [ + 'description' => '包年包月实例到期时间。', + 'type' => 'string', + 'example' => '2022-06-13T16:00:00Z', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机的ID。', + 'type' => 'string', + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + 'ResourceGroupId' => [ + 'description' => '实例所属的资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyiu4ekp****', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'InstanceStatus' => [ + 'description' => '实例状态，取值：'."\n" + .'* **Normal**：运行中。'."\n" + .'* **Creating**：创建中。'."\n" + .'* **Changing**：修改中。'."\n" + .'* **Inactive**：被禁用。'."\n" + .'* **Flushing**：清除中。'."\n" + .'* **Released**：已释放。'."\n" + .'* **Transforming**：转换中。'."\n" + .'* **Unavailable**：服务停止。'."\n" + .'* **Error**：创建失败。'."\n" + .'* **Migrating**：迁移中。'."\n" + .'* **BackupRecovering**：备份恢复中。'."\n" + .'* **MinorVersionUpgrading**：小版本升级中。'."\n" + .'* **NetworkModifying**：网络变更中。'."\n" + .'* **SSLModifying**：SSL变更中。'."\n" + .'* **MajorVersionUpgrading**：大版本升级中，可正常访问。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'SecondaryZoneId' => [ + 'description' => '备可用区ID。'."\n" + .'> 当实例存在备可用区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' => '查询实例概览', + 'description' => '若您未指定请求参数，将返回所有实例的信息概览。'."\n" + .'> 该接口返回结果均无分页。', + ], + 'DescribeInstances' => [ + 'summary' => '查询一个或多个云数据库 Tair（兼容 Redis）实例的信息。', + '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' => '实例所属的地域ID。'."\n" + ."\n" + .'> 调用本接口时，如果传入了**Tag**参数，则本参数必须传入。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的实例ID。'."\n" + .'> 如需传入多个实例ID时，使用英文逗号（,）分隔实例ID，最多一个请求传入 30 个实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'InstanceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '实例状态，取值：'."\n" + .'* **Normal**：正常。'."\n" + .'* **Creating**：创建中。'."\n" + .'* **Changing**：修改中。'."\n" + .'* **Inactive**：被禁用。'."\n" + .'* **Flushing**：清除中。'."\n" + .'* **Released**：已释放。'."\n" + .'* **Transforming**：转换中。'."\n" + .'* **Migrating**：迁移中。'."\n" + .'* **BackupRecovering**：备份恢复中。'."\n" + .'* **MinorVersionUpgrading**：小版本升级中。'."\n" + .'* **NetworkModifying**：网络变更中。'."\n" + .'* **SSLModifying**：SSL变更中。'."\n" + .'* **MajorVersionUpgrading**：大版本升级中，可正常访问。'."\n" + ."\n" + .'> 更多实例状态及详细信息，请参见[实例状态与影响](~~200740~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值：'."\n" + .'* **PrePaid**：预付费，即包年包月。'."\n" + .'* **PostPaid**：后付费，即按量付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '网络类型，取值：'."\n" + .'* **CLASSIC**：经典网络。'."\n" + .'* **VPC**：专有网络。', + 'type' => 'string', + 'required' => false, + 'example' => 'CLASSIC', + 'enum' => [ + 'CLASSIC', + 'VPC', + ], + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '实例兼容Redis的版本，取值：**2.8**、**4.0**、**5.0**、**6.0**或**7.0**。', + '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' => '实例规格，请参见[实例规格表](~~107984~~)。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'redis.master.small.default', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '实例列表的页码，起始值为**1**，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页最多可显示的行数，最大值为**50**，默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型，取值：'."\n" + .'* **Tair**：Tair（企业版）'."\n" + .'* **Redis**：Redis开源版'."\n" + .'* **Memcache**', + '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' => '支持模糊搜索实例名称或实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'apitest', + ], + ], + [ + 'name' => 'ArchitectureType', + 'in' => 'query', + 'schema' => [ + 'description' => '架构类型，取值：'."\n" + .'* **cluster**：集群版。'."\n" + .'* **standard**：标准版。'."\n" + .'* **rwsplit**：读写分离版。', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + ], + ], + [ + 'name' => 'Expired', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的过期状态，取值：'."\n" + ."\n" + .'* **true**：已过期。'."\n" + .'* **false**：未过期。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hongkong-b', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + .'> 您可以通过调用[ListResourceGroups](~~158855~~)接口或通过控制台获取资源组ID列表。相关操作，请参见[查看资源组基本信息](~~151181~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'GlobalInstance', + 'in' => 'query', + 'schema' => [ + 'description' => '返回的实例列表中，是否过滤分布式实例中的子实例，取值：'."\n" + .'* **true**：只返回子实例信息。'."\n" + .'* **false**：不返回子实例信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EditionType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型，取值：'."\n" + .'* **Community**：Redis开源版。'."\n" + .'* **Enterprise**：Tair企业版。', + 'type' => 'string', + 'required' => false, + 'example' => 'Enterprise', + 'enum' => [ + 'Enterprise', + 'Community', + ], + ], + ], + [ + 'name' => 'PrivateIp', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.49.***', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例的标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '标签键的值，与Tag Key组成标签的键值对。', + 'type' => 'string', + 'required' => false, + 'example' => '开发', + ], + 'Key' => [ + 'description' => '标签的键，与Tag Value组成标签的键值对。'."\n" + .'> 单次最多支持传入5组标签的键值对。', + 'type' => 'string', + 'required' => false, + 'example' => '存储类型', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型，取值：'."\n" + .'* **MASTER_SLAVE**：高可用（双副本）'."\n" + .'* **STAND_ALONE**：单副本'."\n" + .'* **double**：双副本'."\n" + .'* **single**：单副本'."\n" + .'> 云原生版实例请选择**MASTER_SLAVE**或**STAND_ALONE**，经典版实例请选择**double**或**single**。', + 'type' => 'string', + 'required' => false, + 'example' => 'MASTER_SLAVE', + 'enum' => [ + 'STAND_ALONE', + 'MASTER_SLAVE', + 'double', + 'single', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1E83311F-0EE4-4922-A3BF-730B312B****', + ], + 'PageNumber' => [ + 'description' => '实例列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '输入时设置的每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '实例总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Instances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'KVStoreInstance' => [ + 'description' => '由Instance组成的集合。', + 'type' => 'array', + 'items' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'Connections' => [ + 'description' => '实例的连接数限制。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'EndTime' => [ + 'description' => '包年包月实例到期时间。', + 'type' => 'string', + 'example' => '2019-06-13T16:00:00Z', + ], + 'ResourceGroupId' => [ + 'description' => '实例所属的资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyiu4ekp****', + ], + 'EditionType' => [ + 'description' => '实例类型，取值：'."\n" + .'- **Community**：社区版。'."\n" + .'- **Enterprise**：企业版。', + 'type' => 'string', + 'example' => 'Enterprise', + ], + 'Config' => [ + 'description' => '实例的参数设置情况，详情请参见[参数设置](~~43885~~)。', + 'type' => 'string', + 'example' => '{\\"maxmemory-policy\\":\\"volatile-lfu\\",\\"EvictionPolicy\\":\\"volatile-lru\\",\\"hash-max-ziplist-entries\\":512,\\"zset-max-ziplist-entries\\":128,\\"zset-max-ziplist-value\\":64,\\"set-max-intset-entries\\":512,\\"hash-max-ziplist-value\\":64,\\"#no_loose_disabled-commands\\":\\"flushall,flushdb\\",\\"lazyfree-lazy-eviction\\":\\"yes\\"}', + ], + 'Port' => [ + 'description' => '实例的服务端口。'."\n" + .'>在实例做过修改网络连接地址的端口之后该字段无法提供实例实际网络状态信息，请使用 DescribeDBInstanceNetInfo API 查询实例实时的对外网络连接信息。>', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6379', + ], + 'DestroyTime' => [ + 'description' => '销毁实例的时间。', + 'type' => 'string', + 'example' => '2019-04-28T10:03:01Z', + ], + 'GlobalInstanceId' => [ + 'description' => '分布式实例ID。'."\n" + .'> 当实例为分布式实例中的子实例时，才会返回该参数。', + 'type' => 'string', + 'example' => 'gr-bp14rkqrhac****', + ], + 'HasRenewChangeOrder' => [ + 'description' => '是否有未生效的续费变配订单，返回值：'."\n" + .'* **true**：是。'."\n" + .'* **false**：否。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ShardCount' => [ + 'description' => '集群的数据节点数。'."\n" + .'> 云原生版集群或读写分离架构实例才会返回本参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ConnectionDomain' => [ + 'description' => '实例的内网连接地址。'."\n" + .'>在实例做过修改、申请新的网络连接地址的之后该字段无法提供实例实际网络状态信息，请使用 DescribeDBInstanceNetInfo API 查询实例实时的对外网络连接信息。>', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', + ], + 'SlaveReplicaCount' => [ + 'description' => '备可用区的备节点数（个）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PrivateIp' => [ + 'description' => '专有网络IP地址。'."\n" + .'> 实例的网络类型为经典网络时，不会返回本参数。', + 'type' => 'string', + 'example' => '172.16.49.***', + ], + 'Capacity' => [ + 'description' => '实例容量， 单位：MB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4096', + ], + 'QPS' => [ + 'description' => '每秒请求数（Queries per Second）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'NetworkType' => [ + 'description' => '网络类型，返回值：'."\n" + .'* **CLASSIC**：经典网络。'."\n" + .'* **VPC**：专有网络。', + 'type' => 'string', + 'example' => 'CLASSIC', + ], + 'InstanceStatus' => [ + 'description' => '实例状态，返回值：'."\n" + .'* **Normal**：正常。'."\n" + .'* **Creating**：创建中。'."\n" + .'* **Changing**：修改中。'."\n" + .'* **Inactive**：被禁用。'."\n" + .'* **Flushing**：清除中。'."\n" + .'* **Released**：已释放。'."\n" + .'* **Transforming**：转换中。'."\n" + .'* **Unavailable**：服务停止。'."\n" + .'* **Error**：创建失败。'."\n" + .'* **Migrating**：迁移中。'."\n" + .'* **BackupRecovering**：备份恢复中。'."\n" + .'* **MinorVersionUpgrading**：小版本升级中。'."\n" + .'* **NetworkModifying**：网络变更中。'."\n" + .'* **SSLModifying**：SSL变更中。'."\n" + .'* **MajorVersionUpgrading**：大版本升级中，可正常访问。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'PackageType' => [ + 'description' => '套餐类型，返回值：'."\n" + .'* **standard**：标准套餐。'."\n" + .'* **customized**：定制套餐。', + 'type' => 'string', + 'example' => 'standard', + ], + 'Bandwidth' => [ + 'description' => '实例带宽，单位：MB/s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '96', + ], + 'InstanceType' => [ + 'description' => '实例类型，返回值：'."\n" + .'* **Tair**。'."\n" + .'* **Redis**。'."\n" + .'* **Memcache**。', + 'type' => 'string', + 'example' => 'Redis', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => 'Tag的Value。', + 'type' => 'string', + 'example' => 'value1', + ], + 'Key' => [ + 'description' => 'Tag的Key。', + 'type' => 'string', + 'example' => 'key1', + ], + ], + ], + ], + ], + ], + 'ReplacateId' => [ + 'description' => '多活实例的逻辑ID。', + 'type' => 'string', + 'example' => 'grr-bp11381ebc16****', + ], + 'ArchitectureType' => [ + 'description' => '架构类型，返回值：'."\n" + .'* **cluster**：集群版。'."\n" + .'* **standard**：标准版。'."\n" + .'* **rwsplit**：读写分离版。'."\n" + .'* **NULL**：所有类型，默认值。 ', + 'type' => 'string', + 'example' => 'cluster', + ], + 'EngineVersion' => [ + 'description' => '实例兼容Redis的版本。', + 'type' => 'string', + 'example' => '4.0', + ], + 'UserName' => [ + 'description' => '连接使用的用户名，默认包含有一个以实例ID命名的用户名。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'CloudType' => [ + 'description' => '仅云盒实例显示该参数。', + 'type' => 'string', + 'example' => 'cloudbox', + ], + 'InstanceId' => [ + 'description' => '实例的ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'ShardClass' => [ + 'description' => '数据分片节点规格，规格详情请参见[规格查询导航](~~26350~~)。'."\n" + .'> 集群架构实例的整体性能为：分片节点规格（ShardClass） * 分片数（ShardCount）。', + 'type' => 'string', + 'example' => 'redis.shard.small.ce', + ], + 'CreateTime' => [ + 'description' => '实例的创建时间。', + 'type' => 'string', + 'example' => '2018-11-07T08:49:00Z', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机的ID。', + 'type' => 'string', + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + 'ReplicaCount' => [ + 'description' => '主可用区的备节点数（个）。'."\n" + .'> **ReplicaCount**与**SlaveReplicaCount**参数仅适用于云原生版实例。如果实例为集群架构，则上述参数分别表示**单分片**的（主、备可用区）备节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ReadOnlyCount' => [ + 'description' => '主可用区的只读节点数（个）。'."\n" + .'> **ReadOnlyCount**与**SlaveReadOnlyCount**参数仅适用于云原生版、开启读写分离的实例。如果实例为集群架构，则上述参数分别表示**单分片**的（主、备可用区）只读节点数量。', + 'type' => 'string', + 'example' => '1', + ], + 'InstanceClass' => [ + 'description' => '实例的规格。', + 'type' => 'string', + 'example' => 'redis.logic.sharding.2g.2db.0rodb.4proxy.default', + ], + 'IsRds' => [ + 'description' => '是否属RDS管控，返回值：'."\n" + .'* **true**：是。'."\n" + .'* **false**：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SecondaryZoneId' => [ + 'description' => '备可用区ID。'."\n" + .'> 若**ZoneId**参数已返回多可用区，例如"cn-hangzhou-MAZ10(h,i)"，本参数将不返回备可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'InstanceName' => [ + 'description' => '实例的名称。', + 'type' => 'string', + 'example' => 'apitest', + ], + 'SlaveReadOnlyCount' => [ + 'description' => '备可用区的只读节点数（个）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VpcId' => [ + 'description' => '专有网络（VPC）的ID。', + 'type' => 'string', + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + 'ChargeType' => [ + 'description' => '付费类型，返回值：'."\n" + .'* **PrePaid**：预付费。'."\n" + .'* **PostPaid**：后付费。', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'ComputingType' => [ + 'description' => '实例计算类型，返回值:'."\n" + ."\n" + .'- **Ecs**: 云原生'."\n" + .'- **Machine**: 物理机', + 'type' => 'string', + 'example' => 'Ecs', + ], + 'NodeType' => [ + 'description' => '节点类型，返回值：'."\n" + .'* **double**：双副本。'."\n" + .'* **single**：单副本（已下线）。'."\n" + .'* **MASTER_SLAVE**：高可用（双副本）。'."\n" + .'* **STAND_ALONE**：单副本。', + 'type' => 'string', + 'example' => 'double', + ], + 'ConnectionMode' => [ + 'description' => '实例的访问模式，返回值：'."\n" + .'* **Standard**：标准访问模式。'."\n" + .'* **Safe**：数据库代理模式。'."\n" + ."\n" + .'已废弃，请使用Describedbinstancenetinfo代替查询', + 'type' => 'string', + 'example' => 'Standard', + ], + 'RegionId' => [ + 'description' => '地域ID。', + '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' => '查询实例的列表信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDedicatedClusterInstanceList' => [ + 'summary' => '查询专属集群中的云数据库 Tair（兼容 Redis）实例信息。', + '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' => '地域ID，您可以调用[DescribeRegions](~~473763~~)查询。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID，您可以调用[DescribeZones](~~473764~~)查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-e', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + .'> 该实例必须是通过专属集群创建的，更多信息，请参见[云数据库专属集群MyBase](~~141455~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'InstanceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '实例状态，取值：'."\n" + .'* **0**：创建中。'."\n" + .'* **1**：运行中。'."\n" + .'* **3**：删除中。'."\n" + .'* **5**：变配中。'."\n" + .'* **6**：迁移中。'."\n" + .'* **7**：备份恢复中。'."\n" + .'* **8**：切换中。'."\n" + .'* **9**：删除过期数据。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceNetType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例连接地址的网络类型，取值：'."\n" + .'* **0**：公网。'."\n" + .'* **1**：经典网络。'."\n" + .'* **2**：专有网络VPC。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型，取值固定为**Redis**。', + 'type' => 'string', + 'required' => false, + 'example' => 'Redis', + 'default' => 'Redis', + 'enum' => [ + 'Redis', + ], + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库版本号，取值固定为**5.0**。', + 'type' => 'string', + 'required' => false, + 'example' => '5.0', + 'enum' => [ + '5.0', + '6.0', + ], + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '专属集群ID，可在专属集群控制台的专属集群信息页获取。'."\n" + .'> 如需传入多个，ID间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'dhg-5f2v98840ioq****', + ], + ], + [ + 'name' => 'DedicatedHostName', + 'in' => 'query', + 'schema' => [ + 'description' => '专属集群的主机ID，可调用[DescribeDedicatedHosts](~~200944~~)获取。'."\n" + .'> 如需传入多个，ID间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'ch-t4n664a9mal4c****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于**0**且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页可展示的最大记录数，取值：**30**、**50**、**100**，默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页可展示的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '712CCF2A-16BD-411B-93F7-E978BEF2****', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Instances' => [ + 'description' => '实例信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例信息列表。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络VPC ID。', + 'type' => 'string', + 'example' => 'vpc-t4n2clc70t3hqwsrr****', + ], + 'CharacterType' => [ + 'description' => '架构类型，返回值：'."\n" + .'* **logic**：集群架构。'."\n" + .'* **normal**：标准架构。', + 'type' => 'string', + 'example' => 'logic', + ], + 'VswitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-t4nvrca24dczppq44****', + ], + 'InstanceClass' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => 'redis.cluster.sharding.common.ce', + ], + 'MaintainStartTime' => [ + 'description' => '可维护时间段的开始时间，格式为HH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '16:00Z', + ], + 'CreateTime' => [ + 'description' => '实例的创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-05-06T07:09:40Z', + ], + 'ConnectionDomain' => [ + 'description' => '直连地址。', + 'type' => 'string', + 'example' => 'r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com', + ], + 'MaintainEndTime' => [ + 'description' => '可维护时间段的结束时间，格式为HH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '17:00Z', + ], + 'StorageType' => [ + 'description' => '存储类型，返回值固定为LOCAL_SSD（[ESSD云盘](~~122389~~)）。', + 'type' => 'string', + 'example' => 'LOCAL_SSD', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1e7vl6ygf1yq****', + ], + 'BandWidth' => [ + 'description' => '实例的默认带宽，单位为MB/s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'CurrentBandWidth' => [ + 'description' => '实例当前的带宽，单位为MB/s，由默认带宽和增加的带宽组成。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'EngineVersion' => [ + 'description' => '数据库版本，返回值固定为**5.0**。', + 'type' => 'string', + 'example' => '5.0', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'testdb', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-e', + ], + 'ClusterName' => [ + 'description' => '专属集群名称。', + 'type' => 'string', + 'example' => 'testname', + ], + 'InstanceStatus' => [ + 'description' => '实例状态，返回值：'."\n" + .'* **Normal**：正常。'."\n" + .'* **Creating**：创建中。'."\n" + .'* **Changing**：修改中。'."\n" + .'* **Inactive**：被禁用。'."\n" + .'* **Flushing**：清除中。'."\n" + .'* **Released**：已释放。'."\n" + .'* **Transforming**：转换中。'."\n" + .'* **Unavailable**：服务停止。'."\n" + .'* **Error**：创建失败。'."\n" + .'* **Migrating**：迁移中。'."\n" + .'* **BackupRecovering**：备份恢复中。'."\n" + .'* **MinorVersionUpgrading**：小版本升级中。'."\n" + .'* **NetworkModifying**：网络变更中。'."\n" + .'* **SSLModifying**：SSL变更中。'."\n" + .'* **MajorVersionUpgrading**：大版本升级中，可正常访问。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Engine' => [ + 'description' => '数据库类型，返回值固定为**redis**。', + 'type' => 'string', + 'example' => 'redis', + ], + 'ShardCount' => [ + 'description' => '数据分片数量。'."\n" + .'> 仅当实例为[集群架构](~~52228~~)时，才会返回本参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CustomId' => [ + 'description' => '内部参数，维护实例使用。', + 'type' => 'string', + 'example' => '4652****', + ], + 'ProxyCount' => [ + 'description' => '代理节点数量。'."\n" + ."\n" + .'> * 返回值为**0**时，表示实例未开启代理模式；返回值为大于**0**的整数时（例如**1**），表示实例已开启代理模式。'."\n" + .'> * 仅当实例为[集群架构](~~52228~~)时，才会返回本参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterId' => [ + 'description' => '专属集群ID。', + 'type' => 'string', + 'example' => 'dhg-rx71fc5ndh9o****', + ], + 'InstanceNodeList' => [ + 'description' => '节点信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例节点的列表。', + 'type' => 'object', + 'properties' => [ + 'NodeIp' => [ + 'description' => '节点IP地址。', + 'type' => 'string', + 'example' => '10.0.33.***', + ], + 'DedicatedHostName' => [ + 'description' => '专属集群的主机ID。', + 'type' => 'string', + 'example' => 'ch-bp13vf0y9gx3c****', + ], + 'NodeType' => [ + 'description' => '节点类型，返回值：'."\n" + .'* **db**：数据节点。'."\n" + .'* **proxy**：代理节点。'."\n" + .'* **normal**：普通节点（标准架构的实例会返回该值）。', + 'type' => 'string', + 'example' => 'normal', + ], + 'ZoneId' => [ + 'description' => '节点所属的可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1e7vl6ygf1yq****', + ], + 'Port' => [ + 'description' => '节点的端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3001', + ], + 'Role' => [ + 'description' => '节点角色，返回值：'."\n" + .'* **master**：主节点。'."\n" + .'* **slave**：备节点。', + 'type' => 'string', + 'example' => 'master', + ], + 'NodeId' => [ + 'description' => '节点ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '17921111', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看专属集群实例的列表', + 'description' => '> 如需查询非专属集群下的实例的信息，请调用[DescribeInstanceAttribute](~~473779~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceAttribute' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的详细信息。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CA40C261-EB72-4EDA-AC57-958722162595', + ], + 'Instances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DBInstanceAttribute' => [ + 'description' => '实例详细信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络（VPC）的ID。', + 'type' => 'string', + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + 'PrivateIp' => [ + 'description' => '专有网络IP地址。'."\n" + .'> 实例的网络类型为经典网络时，不会返回本参数。', + 'type' => 'string', + 'example' => '172.16.49.***', + ], + 'Capacity' => [ + 'description' => '存储容量，单位：MB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'CreateTime' => [ + 'description' => '实例创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2019-03-06T10:42:03Z', + ], + 'ConnectionDomain' => [ + 'description' => '实例的内网连接地址。', + 'type' => 'string', + 'example' => 'r-bp1d72gwl41z7f****.redis.rds.aliyuncs.com', + ], + 'IsRds' => [ + 'description' => '是否属RDS管控，返回值：'."\n" + .'* **true**：是。'."\n" + .'* **false**：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ChargeType' => [ + 'description' => '付费类型，返回值：'."\n" + .'* **PrePaid**：预付费，即包年包月。'."\n" + .'* **PostPaid**：后付费，即按量付费。', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'StorageType' => [ + 'description' => '存储类型。', + 'type' => 'string', + 'example' => 'essd_pl1', + ], + 'VpcAuthMode' => [ + 'description' => 'VPC认证模式，返回值：'."\n" + .'* **Open**：需要密码认证。'."\n" + .'* **Close**：关闭密码认证，即开启了[VPC免密功能](~~85168~~)。', + 'type' => 'string', + 'example' => 'Open', + ], + 'ArchitectureType' => [ + 'description' => '实例的架构，返回值：'."\n" + .'* **cluster**：集群版。'."\n" + .'* **standard**：标准版。'."\n" + .'* **rwsplit**：读写分离版。', + 'type' => 'string', + 'example' => 'standard', + ], + 'AvailabilityValue' => [ + 'description' => '当月的可用性指标。', + 'type' => 'string', + 'example' => '100%', + ], + 'NetworkType' => [ + 'description' => '网络类型，返回值：'."\n" + .'* **CLASSIC**：经典网络。'."\n" + .'* **VPC**：专有网络。', + 'type' => 'string', + 'example' => 'CLASSIC', + ], + 'Port' => [ + 'description' => '实例的服务端口。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6379', + ], + 'SecondaryZoneId' => [ + 'description' => '备可用区ID。'."\n" + .'> 实例没有备可用区ID时，不返回本参数。', + 'type' => 'string', + 'example' => 'cn-hongkong-h', + ], + 'PackageType' => [ + 'description' => '套餐类型，返回值：'."\n" + .'* **standard**：标准套餐。'."\n" + .'* **customized**：定制套餐，已下线。', + 'type' => 'string', + 'example' => 'standard', + ], + 'EngineVersion' => [ + 'description' => '实例兼容Redis的版本，返回值：**2.8**、**4.0**、**5.0**、**6.0**或**7.0**。', + 'type' => 'string', + 'example' => '4.0', + ], + 'Config' => [ + 'description' => '实例的参数配置信息，格式为JSON，详情请参见[参数说明](~~43885~~)，'."\n" + .'查看审计日志配置可使用[DescribeAuditLogConfig](~~473830~~)接口。', + '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' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'r-bp1d72gwl41z7f****', + ], + 'Bandwidth' => [ + 'description' => '带宽，单位：MB/s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'apitest', + ], + 'SecurityIPList' => [ + 'description' => 'IP白名单。', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'ShardCount' => [ + 'description' => '分片数，本参数仅适用于中国站。'."\n" + ."\n" + .'当实例为[集群架构](~~52228~~)的云原生版实例时，才会返回本参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ReplicaCount' => [ + 'description' => '主可用区的备节点数（个）。'."\n" + .'> **ReplicaCount**与**SlaveReplicaCount**参数仅适用于云原生版实例。如果实例为集群架构，则上述参数分别表示**单分片**的（主、备可用区）备节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SlaveReplicaCount' => [ + 'description' => '备可用区的备节点数（个）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ReadOnlyCount' => [ + 'description' => '主可用区的只读节点数（个）。'."\n" + .'> **ReadOnlyCount**与**SlaveReadOnlyCount**参数仅适用于云原生版、开启读写分离的实例。如果实例为集群架构，则上述参数分别表示**单分片**的（主、备可用区）只读节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SlaveReadOnlyCount' => [ + 'description' => '备可用区的只读节点数，该参数仅在多可用区中开启读写分离后才会返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'GlobalInstanceId' => [ + 'description' => '所属的分布式实例ID。'."\n" + .'> 当Redis实例为分布式实例中的子实例时，才会返回本参数。', + 'type' => 'string', + 'example' => 'gr-bp14rkqrhac****', + ], + 'QPS' => [ + 'description' => '理论最大QPS值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'AuditLogRetention' => [ + 'description' => '审计日志中设置的日志保留时间，单位为天。0代表未开通审计日志，开通方式请参见[开通审计日志](~~102015~~)。', + 'type' => 'string', + 'example' => '15', + ], + 'ZoneType' => [ + 'description' => '可用区类型，返回值：'."\n" + .'* **singlezone**：同城单可用区。'."\n" + .'* **doublezone**：同城双可用区。', + 'type' => 'string', + 'example' => 'singlezone', + ], + 'MaintainStartTime' => [ + 'description' => '可运维开始时间，格式为HH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '18:00Z', + ], + 'MaintainEndTime' => [ + 'description' => '可运维结束时间，格式为HH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '22:00Z', + ], + 'InstanceClass' => [ + 'description' => '实例规格，请参见[实例规格表](~~107984~~)。', + 'type' => 'string', + 'example' => 'redis.master.small.default', + ], + 'RealInstanceClass' => [ + 'description' => '当实例为云原生版集群实例时，本参数为云原生版集群实例的实际分片规格，InstanceClass参数为虚拟规格。'."\n" + .'> 如需查询该规格的实例费用，可在[DescribePrice](~~473807~~)接口中指定本参数返回的实例规格进行查询。', + 'type' => 'string', + 'example' => 'tair.rdb.with.proxy.1g', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1d72gwl41z7f****', + ], + 'InstanceType' => [ + 'description' => '实例类型，返回值：'."\n" + .'- **Tair**'."\n" + .'- **Redis**
其中经典版Tair内存型也会返回Redis实例类型。 '."\n" + .'- **Memcache**', + 'type' => 'string', + 'example' => 'Redis', + ], + 'HasRenewChangeOrder' => [ + 'description' => '是否有未生效的续费变配订单，返回值：'."\n" + .'* **true**：是。'."\n" + .'* **false**：否。', + 'type' => 'string', + 'example' => 'false', + ], + 'InstanceReleaseProtection' => [ + 'description' => '是否开启了实例释放保护，返回值：'."\n" + .'* **true**：已开启。'."\n" + .'* **false**：未开启。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ReplicationMode' => [ + 'description' => '副本架构，返回值：'."\n" + .'* **master-slave**：标准版的主备架构。'."\n" + .'* **cluster**：集群架构，包含读写分离版或集群版。'."\n" + .'* **db**：云原生分片集群架构。', + 'type' => 'string', + 'example' => 'master-slave', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'EndTime' => [ + 'description' => '预付费实例到期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2019-04-06T10:42:03Z', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + 'ReplicaId' => [ + 'description' => '副本ID。', + 'type' => 'string', + 'example' => 'bls-awxxxxxxxxxxxxx', + ], + 'NodeType' => [ + 'description' => '节点类型，返回值：'."\n" + .'* **double**：双副本。'."\n" + .'* **single**：单副本。'."\n" + .'* **readone**：经典架构读写分离实例，一个只读节点。'."\n" + .'* **readthree**：经典架构读写分离实例，三个只读节点。', + 'type' => 'string', + 'example' => 'double', + ], + 'Connections' => [ + 'description' => '实例连接数限制。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'BackupLogStartTime' => [ + 'description' => '允许闪回的最早时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> * 当Redis实例开启了[数据闪回](~~148479~~)功能，才会返回本参数。'."\n" + .'> * 调用[RestoreInstance](~~473824~~)接口执行数据闪回时，可通过本参数的返回值确认允许闪回的最早时间点（即**RestoreTime**可传入的最早时间点）。', + 'type' => 'string', + 'example' => '2021-07-06T05:49:55Z', + ], + 'ResourceGroupId' => [ + 'description' => '实例所属的资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyiu4ekp****', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hongkong-b', + ], + 'InstanceStatus' => [ + 'description' => '实例状态，返回值：'."\n" + .'* **Normal**：正常。'."\n" + .'* **Creating**：创建中。'."\n" + .'* **Changing**：修改中。'."\n" + .'* **Inactive**：被禁用。'."\n" + .'* **Flushing**：清除中。'."\n" + .'* **Released**：已释放。'."\n" + .'* **Transforming**：转换中。'."\n" + .'* **Migrating**：迁移中。'."\n" + .'* **BackupRecovering**：备份恢复中。'."\n" + .'* **MinorVersionUpgrading**：小版本升级中。'."\n" + .'* **NetworkModifying**：网络变更中。'."\n" + .'* **SSLModifying**：SSL变更中。'."\n" + .'* **MajorVersionUpgrading**：大版本升级中，可正常访问。'."\n" + ."\n" + .'> 更多实例状态及详细信息，请参见[实例状态与影响](~~200740~~)。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Engine' => [ + 'description' => '数据库类型，返回值固定为**Redis**。', + 'type' => 'string', + 'example' => 'Redis', + ], + 'Storage' => [ + 'description' => 'Tair ESSD磁盘型的存储空间。', + 'type' => 'string', + 'example' => '50', + ], + 'CloudType' => [ + 'description' => '仅云盒实例显示该参数。', + 'type' => 'string', + 'example' => 'cloudbox', + ], + 'IsOrderCompleted' => [ + 'description' => '实例订单是否完成，用于判断变配订单是否到达终态，返回值：'."\n" + .'* **true**：变配已完成，或进行未变配。'."\n" + .'* **false**：变配中。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsSupportTDE' => [ + 'description' => '实例是否支持开启透明数据加密TDE（Transparent Data Encryption）功能，返回值：'."\n" + .'* **true**：支持，仅经典版内存型实例支持。'."\n" + .'* **false**：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签key。', + 'type' => 'string', + 'example' => 'tagkey', + ], + 'Value' => [ + 'description' => '标签value。', + 'type' => 'string', + 'example' => 'tagvalue', + ], + ], + ], + ], + ], + ], + 'AutoSecondaryZone' => [ + 'description' => '自动分配 Secondary 可用区。'."\n" + .'* **true**：自动分配'."\n" + .'* **false**：非自动分配', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ComputingType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询实例的详细信息', + ], + 'DescribeGlobalDistributeCache' => [ + 'summary' => '查询分布式实例的详细信息。', + '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' => '分布式实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'gr-bp14rkqrhac****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于**0**且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'SubInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '子实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'gr-bp1zcjlobkyrq****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页可展示的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F3F44BE3-5419-4B61-9BAC-E66E295A****', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GlobalDistributeCaches' => [ + 'description' => '分布式实例详细信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '分布式实例状态，返回值：'."\n" + .'* **Normal**：运行中。'."\n" + .'* **Changing**：修改中。'."\n" + .'* **Creating**：创建中。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'GlobalInstanceId' => [ + 'description' => '分布式实例ID。', + 'type' => 'string', + 'example' => 'gr-bp14rkqrhac****', + ], + 'SubInstances' => [ + 'description' => '子实例详细信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceStatus' => [ + 'description' => '子实例状态，返回值：'."\n" + ."\n" + .'* **Normal**：正常。'."\n" + .'* **Creating**：创建中。'."\n" + .'* **Changing**：修改中。'."\n" + .'* **Inactive**：被禁用。'."\n" + .'* **Flushing**：清除中。'."\n" + .'* **Released**：已释放。'."\n" + .'* **Transforming**：转换中。'."\n" + .'* **Unavailable**：服务停止。'."\n" + .'* **Error**：创建失败。'."\n" + .'* **Migrating**：迁移中。'."\n" + .'* **BackupRecovering**：备份恢复中。'."\n" + .'* **MinorVersionUpgrading**：小版本升级中。'."\n" + .'* **NetworkModifying**：网络变更中。'."\n" + .'* **SSLModifying**：SSL变更中。'."\n" + .'* **MajorVersionUpgrading**：大版本升级中，可正常访问。'."\n" + ."\n" + .'> 更多实例状态及详细信息，请参见[实例状态与影响](~~200740~~)。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'InstanceID' => [ + 'description' => '子实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'InstanceClass' => [ + 'description' => '子实例规格。更多信息，请参见：'."\n" + .'* [内存型标准版规格](~~145228~~)。'."\n" + .'* [内存型集群版规格](~~150458~~)。'."\n" + .'* [内存型读写分离版规格](~~150459~~)。', + 'type' => 'string', + 'example' => 'redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread', + ], + 'GlobalInstanceId' => [ + 'description' => '分布式实例ID。', + 'type' => 'string', + 'example' => 'gr-bp14rkqrhac****', + ], + 'RegionId' => [ + 'description' => '地域ID。', + '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' => '查询分布式实例的详细信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeEngineVersion' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的大版本和小版本信息，同时可查询到小版本的发布日志信息。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsLatestVersion' => [ + 'description' => '实例的小版本是否为最新，返回值：'."\n" + .'* **true**：是。'."\n" + .'* **false**：不是。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A52974D1-9D57-4805-86CC-92E6EDE8****', + ], + 'ProxyMinorVersion' => [ + 'description' => 'Proxy代理节点当前的小版本。'."\n" + .'> 仅集群与读写分离架构实例返回本参数。', + 'type' => 'string', + 'example' => '6.6.0', + ], + 'DBVersionRelease' => [ + 'description' => '实例小版本的更新说明，包含发布时间、小版本号、类型（例如新特性）及详细说明等信息。', + 'type' => 'string', + 'example' => '{\\"releaseInfo\\":{\\"createTime\\":\\"2021-07-27\\",\\"level\\":1,\\"releaseVersion\\":\\"0.5.4\\",\\"releaseNote\\":\\"功能更新：增强稳定性。\\"}],\\"versionChangesLevel\\":2}', + ], + 'ProxyVersionRelease' => [ + 'description' => 'Proxy代理节点的小版本更新说明，包含发布时间、小版本号、类型（例如新特性）及详细说明等信息。'."\n" + .'> 仅集群与读写分离架构实例返回本参数。', + 'type' => 'string', + 'example' => '{\\"releaseInfo\\":[{\\"createTime\\":\\"2021-06-08\\",\\"level\\":0,\\"releaseVersion\\":\\"6.6.2\\",\\"releaseNote\\":\\"新特性：增加对部分内部命令的支持。\\"}],\\"versionChangesLevel\\":2}', + ], + 'EnableUpgradeMajorVersion' => [ + 'description' => '实例是否可升级大版本，返回值：'."\n" + .'* **true**：可升级。'."\n" + .'* **false**：不可升级，通常已经是最新版本。'."\n" + ."\n" + .'> 如需升级大版本，请调用[ModifyInstanceMajorVersion](~~473776~~)接口。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableUpgradeMinorVersion' => [ + 'description' => '实例是否可升级小版本，返回值：'."\n" + ."\n" + .'* **true**：可升级。'."\n" + .'* **false**：已经是最新版本，不可升级。 '."\n" + ."\n" + .'> 如需升级小版本，请调用[ModifyInstanceMinorVersion](~~473777~~)接口。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MajorVersion' => [ + 'description' => '实例的大版本。', + 'type' => 'string', + 'example' => '5.0', + ], + 'Engine' => [ + 'description' => '数据库类型，返回值：**redis**或**memcache**。', + 'type' => 'string', + 'example' => 'redis', + ], + 'MinorVersion' => [ + 'description' => '实例当前的小版本。', + 'type' => 'string', + 'example' => 'redis-5.0_0.5.0', + ], + 'IsRedisCompatibleVersion' => [ + 'description' => '是否Redis的兼容版本。', + 'type' => 'string', + 'example' => '1', + ], + 'IsSSLEnable' => [ + 'description' => '是否启用SSL，取值：'."\n" + .'* **1**: 开启'."\n" + .'* **0**: 关闭', + 'type' => 'string', + 'example' => '1', + ], + 'IsNewSSLMode' => [ + 'description' => '是否支持新版TLS，取值：'."\n" + .'* **1**: 开启'."\n" + .'* **0**: 关闭', + 'type' => 'string', + 'example' => '1', + ], + 'IsAutoUpgradeOpen' => [ + 'description' => '是否开启了小版本自动升级，取值：'."\n" + ."\n" + .'- **0**：未开启。'."\n" + .'- **1**：开启。', + 'type' => 'string', + 'example' => '0', + ], + 'DBLatestMinorVersion' => [ + 'description' => '该实例当前可升级至最新的小版本信息。', + 'type' => 'object', + 'properties' => [ + 'MinorVersion' => [ + 'description' => '版本号。', + 'type' => 'string', + 'example' => '7.0.1.4', + ], + 'Level' => [ + 'description' => '版本变更的重要性，取值：'."\n" + .'* **0**：一般重要'."\n" + .'* **1**：比较重要'."\n" + .'* **2**：非常重要', + 'type' => 'string', + 'example' => '0', + ], + 'VersionRelease' => [ + 'description' => '从实例当前小版本到最新小版本的版本演进路线，与版本文档一致，可以直接至版本说明文档查看更详细的信息。', + 'type' => 'object', + 'properties' => [ + 'VersionChangesLevel' => [ + 'description' => '版本升级的重要性（推荐升级程度），取值：'."\n" + .'* 0：一般重要'."\n" + .'* 1：比较重要'."\n" + .'* 2：非常重要', + 'type' => 'string', + 'example' => '0', + ], + 'ReleaseInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReleaseInfoList' => [ + 'description' => '小版本信息。', + 'type' => 'array', + 'items' => [ + 'description' => '小版本信息。', + 'type' => 'object', + 'properties' => [ + 'ReleaseVersion' => [ + 'description' => 'EMR发行版。', + 'type' => 'string', + 'example' => 'EMR-5.7.0', + ], + 'CreateTime' => [ + 'description' => '实例的创建时间。', + 'type' => 'string', + 'example' => '2022-11-21T13:28Z', + ], + 'ReleaseNote' => [ + 'description' => '版本发布说明', + 'type' => 'string', + 'example' => '发布说明', + ], + 'Level' => [ + 'description' => '重要等级。', + 'type' => 'string', + 'example' => '0', + ], + 'ReleaseNoteEn' => [ + 'description' => '可升级的版本英文描述。', + 'type' => 'string', + 'example' => '版本升级英文描述', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'ProxyLatestMinorVersion' => [ + 'description' => '该Proxy节点当前可升级至最新的小版本信息。', + 'type' => 'object', + 'properties' => [ + 'MinorVersion' => [ + 'description' => '版本号。', + 'type' => 'string', + 'example' => '7.0.6', + ], + 'Level' => [ + 'description' => '版本变更的重要性，取值：'."\n" + .'* **0**：一般重要'."\n" + .'* **1**：比较重要'."\n" + .'* **2**：非常重要', + 'type' => 'string', + 'example' => '0', + ], + 'VersionRelease' => [ + 'description' => '从实例当前小版本到最新小版本的版本演进路线，与版本文档一致，可以直接至版本说明文档查看更详细的信息。', + 'type' => 'object', + 'properties' => [ + 'ReleaseInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ReleaseInfoList' => [ + 'description' => '小版本信息。', + 'type' => 'array', + 'items' => [ + 'description' => '小版本信息。', + 'type' => 'object', + 'properties' => [ + 'ReleaseVersion' => [ + 'description' => 'EMR发行版。', + 'type' => 'string', + 'example' => 'EMR-5.9.1', + ], + 'CreateTime' => [ + 'description' => '版本的发布时间', + 'type' => 'string', + 'example' => '2022-08-23T14:26:20Z', + ], + 'ReleaseNote' => [ + 'description' => '版本的变更说明', + 'type' => 'string', + 'example' => 'x x x x', + ], + 'Level' => [ + 'description' => '版本变更的重要性，取值：'."\n" + .'* **0**：一般重要'."\n" + .'* **1**：比较重要'."\n" + .'* **2**：非常重要', + 'type' => 'string', + 'example' => '0', + ], + 'ReleaseNoteEn' => [ + 'description' => '可升级的版本英文描述。', + 'type' => 'string', + 'example' => '版本升级英文描述', + ], + ], + ], + ], + ], + ], + 'VersionChangesLevel' => [ + 'description' => '版本升级的重要性（推荐升级程度），取值：'."\n" + .'* 0：一般重要'."\n" + .'* 1：比较重要'."\n" + .'* 2：非常重要', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + 'IsOpenNGLB' => [ + 'description' => '是否开启NGLB模式，取值：'."\n" + .'* **0**：未开启。'."\n" + .'* **1**：开启。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + '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' => '查询实例的大版本和小版本信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRoleZoneInfo' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例中各节点的角色、类型、小版本和所属的可用区。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-t4nlenc2p04uvb****', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的目标节点类型，取值：'."\n" + .'* **0**：Proxy（代理）节点。'."\n" + .' > 该参数仅支持集群与读写分离架构实例。'."\n" + ."\n\n" + .'* **1**：数据节点，默认值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于**0**且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页可展示的记录数，取值：**10**、**20**、**50**，默认值为**10**.', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '224B97FB-A275-4EAC-86E9-8922FEA2****', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页可展示的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Node' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeInfo' => [ + 'description' => '实例中各节点的详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DefaultBandWidth' => [ + 'description' => '节点默认的默认带宽，单位为MB/s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '96', + ], + 'CurrentMinorVersion' => [ + 'description' => '节点当前的小版本。', + 'type' => 'string', + 'example' => 'redis-5.0_0.3.10', + ], + 'CurrentBandWidth' => [ + 'description' => '节点当前的带宽，单位为MB/s，由节点的默认带宽和增加的带宽组成。'."\n" + .'> * 您可以调用[EnableAdditionalBandwidth](~~473771~~)接口设置要增加的带宽。'."\n" + .'> * 通过本参数也可推算出增加的带宽大小，例如节点默认带宽为96 MB/s，本参数返回值为100，则增加了4 MB/s的带宽。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'InsType' => [ + 'description' => '是否为只读节点，如果为只读节点，本参数返回值为**3**。'."\n" + .'> 如果不是只读节点，不返回本参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'IsLatestVersion' => [ + 'description' => '是否为最新的小版本，返回值：'."\n" + .'* **0**：不是最新版本。'."\n" + .'* **1**：是最新版本。'."\n" + ."\n" + .'> 如需升级小版本，请调用[ModifyInstanceMinorVersion](~~473777~~)接口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InsName' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'r-t4nlenc2p04uvb****', + ], + 'NodeType' => [ + 'description' => '节点类型，返回值：'."\n" + .'* **db**：数据节点。'."\n" + .'* **proxy**：代理节点。'."\n" + .'* **normal**：普通节点（标准架构的实例会返回该值）。', + 'type' => 'string', + 'example' => 'normal', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'IsOpenBandWidthService' => [ + 'description' => '该节点是否增加了带宽，取值：'."\n" + .'* **true**：未增加带宽。'."\n" + .'* **false**：已增加带宽。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CustinsId' => [ + 'description' => '数据分片节点ID。', + 'type' => 'string', + 'example' => '30381****', + ], + 'Role' => [ + 'description' => '节点角色，返回值：'."\n" + .'* **master**：主节点。'."\n" + .'* **slave**：备节点。', + 'type' => 'string', + 'example' => 'master', + ], + 'NodeId' => [ + 'description' => '本参数仅作为实例内部维护使用。', + 'type' => 'string', + 'example' => '10065****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询节点和所属可用区信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeClusterMemberInfo' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）集群实例的节点配置信息（例如规格、最大连接数等）。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '实例列表的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页可展示的最大记录数，取值：**30**、**50**、**100**，默认值为**30**。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '2D9F3768-EDA9-4811-943E-42C8006E****', + ], + 'ClusterChildren' => [ + 'description' => '集群实例的数据节点信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Capacity' => [ + 'description' => '单个数据节点的最大内存容量，单位为MB。'."\n" + .'> 当**Service**返回值为**redis**（即节点类型为数据节点）时，才会返回本参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '2****_176498472570****', + ], + 'DiskSizeMB' => [ + 'description' => '数据节点[ESSD云盘](~~122389~~)的存储空间，单位为MB。'."\n" + .'> 该ESSD云盘仅用作系统运行使用（例如数据持久化），不作为数据存取的介质。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4096', + ], + 'BandWidth' => [ + 'description' => '节点的带宽，单位为MB/s。'."\n" + .'> 当**Service**返回值为**redis**（即节点类型为数据节点）时，才会返回本参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '96', + ], + 'CurrentBandWidth' => [ + 'description' => '节点当前的带宽，单位为MB/s，由节点的默认带宽和增加的带宽组成。'."\n" + ."\n" + .'当实例通过专属集群创建时，才会返回本参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ClassCode' => [ + 'description' => '数据节点的规格。更多信息，请参见[云原生版实例规格](~~164477~~)。', + 'type' => 'string', + 'example' => 'redis.shard.small.ce', + ], + 'BizType' => [ + 'description' => '业务类型，返回值固定为**ALIYUN**。', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'Service' => [ + 'description' => '节点类型，返回值：'."\n" + .'* **redis**：数据节点。'."\n" + .'* **redis_cs**：配置服务器节点。', + 'type' => 'string', + 'example' => 'redis', + ], + 'BinlogRetentionDays' => [ + 'description' => 'binlog日志保存天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'Connections' => [ + 'description' => '数据节点的最大连接数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'ResourceGroupName' => [ + 'description' => '节点所属的资源组名称。', + 'type' => 'string', + 'example' => 'GLOBAL_ZHANGJIAKOU_A', + ], + 'ServiceVersion' => [ + 'description' => '节点的大版本。', + 'type' => 'string', + 'example' => '5.0', + ], + 'ReplicaSize' => [ + 'description' => '子节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Name' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****-db-0', + ], + 'Id' => [ + 'description' => '节点的副本集ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '501791111', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询集群的节点配置信息', + 'description' => '> 本接口仅适用于[云原生版实例](~~188068~~)（[集群架构](~~52228~~)）。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBInstanceNetInfo' => [ + 'summary' => '查看云数据库 Tair（兼容 Redis）实例的网络信息。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'Private', + 'Public', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceNetworkType' => [ + 'description' => '网络类型，返回值：'."\n" + .'* **CLASSIC**：经典网络。'."\n" + .'* **VPC**：专有网络。', + 'type' => 'string', + 'example' => 'CLASSIC', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B', + ], + 'NetInfoItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceNetInfo' => [ + 'description' => '实例的网络信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的网络信息列表。', + 'type' => 'object', + 'properties' => [ + 'DirectConnection' => [ + 'description' => '是否为直连地址，返回值：'."\n" + .'* **0**：非直连地址。'."\n" + .'* **1**：直连地址。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机的ID。', + 'type' => 'string', + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + 'DBInstanceNetType' => [ + 'description' => '该网络信息所属的网络类型：'."\n" + .'* **0**：公网。'."\n" + .'* **1**：经典网络。'."\n" + .'* **2**：专有网络。', + 'type' => 'string', + 'example' => '1', + ], + 'Upgradeable' => [ + 'description' => '经典网络连接地址的过期时间，即剩余有效时间，单位为秒。'."\n" + .'> **0**表示不会过期。 ', + 'type' => 'string', + 'example' => '0', + ], + 'ExpiredTime' => [ + 'description' => '实例经典网络地址的有效时间，单位：秒。', + 'type' => 'string', + 'example' => '5183778', + ], + 'ConnectionString' => [ + 'description' => '实例的连接地址。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', + ], + 'IPType' => [ + 'description' => 'IP地址的网络类型，返回值： '."\n" + .'* **Public**：公网。'."\n" + .'* **Inner**：经典网络。 '."\n" + .'* **Private**：VPC网络。', + 'type' => 'string', + 'example' => 'Inner', + ], + 'VPCInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1ky7j6qc7umk****', + ], + 'Port' => [ + 'description' => '实例的服务端口。', + 'type' => 'string', + 'example' => '6379', + ], + 'VPCId' => [ + 'description' => '实例所属的专有网络（VPC）的ID。', + 'type' => 'string', + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + 'IPAddress' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '172.16.49.***', + ], + 'IsSlaveProxy' => [ + 'description' => '表示该地址为备可用区的连接地址，取值为1，表示备可用区。'."\n" + .'> 该地址仅在开通多可用区读写分离架构后返回。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看实例的网络信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDBNodeDirectVipInfo' => [ + 'summary' => '查询集群版直连实例的子实例VIP（Virtual IP Address）信息。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ABAF95F6-35C1-4177-AF3A-70969EBD****', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'DirectVipInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VipInfo' => [ + 'description' => '集群版实例的分片VIP信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群版实例的分片VIP信息。', + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'description' => '分片ID', + 'type' => 'string', + 'example' => 'r-8vb3679b04551444-db-2', + ], + 'Vip' => [ + 'description' => '分片所属的ip地址。', + 'type' => 'string', + 'example' => '100.115.61.8', + ], + 'Port' => [ + 'description' => '端口号，取值范围为**1024**~**65535**，默认值为**6379**。', + 'type' => 'string', + 'example' => '6379', + ], + 'NetType' => [ + 'description' => '安全组的网络类型，返回值：'."\n" + .'* **vpc**：专有网络。', + 'type' => 'string', + 'example' => 'vpc', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询直连实例子实例的VIP', + 'description' => '>只有云原生版实例支持此接口查询。>', + ], + 'DescribeLogicInstanceTopology' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的逻辑拓扑结构。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '实例的ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '794120D1-E0CF-4713-BAE4-EBAEA04506AF', + ], + 'RedisProxyList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeInfo' => [ + 'description' => '代理详情，包含代理节点信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Capacity' => [ + 'description' => '节点的容量，单位为MB。', + 'type' => 'string', + 'example' => '5120', + ], + 'Connection' => [ + 'description' => '连接数限制。', + 'type' => 'string', + 'example' => '320000', + ], + 'NodeType' => [ + 'description' => '节点类型，返回值：'."\n" + .'* **db**：数据节点。'."\n" + .'* **normal**：管理节点，由Proxy节点（代理节点）和CS节点（配置管理节点）组成。部分实例不会返回normal，而是分别返回proxy和cs。', + 'type' => 'string', + 'example' => 'proxy', + ], + 'Bandwidth' => [ + 'description' => '节点的带宽限制，单位为MB/s。', + 'type' => 'string', + 'example' => '96', + ], + 'NodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'r-bp10noxlhcoim2****-proxy-3#542****', + ], + ], + ], + ], + ], + ], + 'RedisShardList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeInfo' => [ + 'description' => '分片详情，包含NodeInfo等子节点信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Capacity' => [ + 'description' => '节点的容量，单位为MB。', + 'type' => 'string', + 'example' => '2048', + ], + 'Connection' => [ + 'description' => '连接数限制。', + 'type' => 'string', + 'example' => '10000', + ], + 'NodeType' => [ + 'description' => '节点类型，返回值：'."\n" + .'* **proxy**：代理节点。'."\n" + .'* **db**：数据节点。', + 'type' => 'string', + 'example' => 'db', + ], + 'Bandwidth' => [ + 'description' => '节点的带宽限制，单位为MB/s。', + 'type' => 'string', + 'example' => '96', + ], + 'NodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'r-bp10noxlhcoim2****-db-0#688****', + ], + 'SubInstanceType' => [ + 'description' => '子实例类型，返回值：'."\n" + .'* **master**：主节点类型。'."\n" + .'* **readonly**：只读实例类型。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'master', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询实例的逻辑拓扑结构', + 'description' => '仅集群与读写分离架构实例支持本接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RestartInstance' => [ + 'summary' => '重启运行中的云数据库 Tair（兼容 Redis）实例。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '重启时间，取值：'."\n" + .'* **Immediately**：默认值，立即重启。'."\n" + .'* **MaintainTime**：可运维时间段重启。', + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => '0', + 'enum' => [ + '0', + '1', + 'Immediately', + 'MaintainTime', + ], + ], + ], + [ + 'name' => 'UpgradeMinorVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '重启时是否将小版本升级到最新版，取值：'."\n" + .'* **true**：升级小版本。'."\n" + .'* **false**：不升级小版本。'."\n" + ."\n" + .'> 默认值：**true**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EFC9161F-15E3-4A6E-8A99-C33331****', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '11111****', + ], + ], + ], + ], + ], + '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' => '重启实例', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'FlushExpireKeys' => [ + 'summary' => '清除云数据库 Tair（兼容 Redis）实例中的过期Key。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '执行时间，取值：'."\n" + .'* **Immediately**：立即执行，默认值。'."\n" + .'* **MaintainTime**：在可维护时间段执行。'."\n" + ."\n" + .'> 您可以调用[ModifyInstanceMaintainTime](~~473775~~)接口修改实例的可维护时间段。', + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => '0', + 'enum' => [ + 'Immediately', + 'MaintainTime', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '82E30AB7-E3A4-46AC-88A0-3E4DCDC5****', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + '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' => '清除过期Key', + 'description' => '该API对应的控制台操作请参见[清除数据](~~43881~~)。'."\n" + ."\n" + .'> 过期key清除后不可恢复，请谨慎使用该接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'FlushInstanceForDB' => [ + 'summary' => '清理云数据库 Tair（兼容 Redis）实例中指定DB的数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，可调用 [DescribeInstances](~~473778~~) 获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'DbIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '指定DB的索引号，取值为[0, 255]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '清理实例指定DB的数据', + 'description' => '云数据库 Tair（兼容 Redis）实例支持256个DB，从DB0到DB255。每个DB没有单独的内存占用量限制，DB可使用的内存容量受该实例的总内存限制。您可以通过`SELECT`命令切换DB，更多信息请参见[Tair DB](~~38688~~)。'."\n" + .'> 本接口仅支持云原生实例（原云盘）集群架构。', + ], + 'FlushInstance' => [ + 'summary' => '清空云数据库 Tair（兼容 Redis）实例中的数据，不可恢复。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '清空实例中的数据', + 'description' => '该API对应的控制台操作请参见[清除数据](~~43881~~)。'."\n" + ."\n" + .'> 调用此API删除数据前请妥善备份数据或确认数据无需备份。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SwitchInstanceHA' => [ + 'summary' => '执行主备切换（即切换节点角色），可应用于容灾演练、多可用区场景下的应用就近连接等需求。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据分片节点ID，您可以调用[DescribeRoleZoneInfo](~~473782~~)获取CustinsId参数，多个数据分片节点ID之间使用英文逗号（,）分隔，如需指定所有节点请输入`all`。'."\n" + .'> 当实例为集群或读写分离架构时，本参数才可用，且必填。', + 'type' => 'string', + 'required' => false, + 'example' => '56****19,56****20', + ], + ], + [ + 'name' => 'SwitchMode', + 'in' => 'query', + 'schema' => [ + 'description' => '执行时间，取值：'."\n" + .'* **0**：立即执行，默认值。'."\n" + .'* **1**：在可维护时间段执行。'."\n" + ."\n" + .'> 您可以调用[ModifyInstanceMaintainTime](~~473775~~)修改实例的可维护时间段。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SwitchType', + 'in' => 'query', + 'schema' => [ + 'description' => '切换模式，取值：'."\n" + .'* **AvailablePriority**：可用性优先，不考虑主备延迟，立即执行主备切换，可能会丢失少量数据。'."\n" + .'* **ReliabilityPriority**：可靠性优先，确保主备同步无延迟时才执行主备切换，不会丢失数据。该模式在写入量较大且持续存在同步延迟的场景下，可能会造成主备切换失败。'."\n" + ."\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' => '请求ID。', + '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' => '切换实例HA', + 'description' => '> 关于多可用区场景下的应用就近连接的详细说明，请参见[场景示例](~~164222~~)。'."\n" + ."\n" + .'调用本接口时，实例类型为高可用或双副本。'."\n" + ."\n" + .'调用本接口将产生下述影响：'."\n" + .'* 触发节点角色切换后，执行切换的数据节点将出现秒级的只读状态和连接闪断，请确保您的应用具备重连机制。'."\n" + .'* 实例处于切换中状态时，您将无法执行实例级别的操作（例如变更配置、迁移可用区等）。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SyncDtsStatus' => [ + 'summary' => '在使用DTS迁移或同步云数据库 Tair（兼容 Redis）实例的数据前，您可以调用本接口限制该实例执行变配操作，避免因变配引起的数据迁移或同步任务失败。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所属的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '是否限制实例执行变配操作，取值：'."\n" + .'* **0**：不限制。'."\n" + .'* **1**：限制，执行变配时将提示用户。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DTS的实例ID，您可以登录[DTS控制台](https://dts.console.aliyun.com/)查看。'."\n" + .'> 由于实例可能同时处于多个DTS的迁移或同步任务中时，当您需要取消对实例的变配限制时，您可以传入本参数以避免重复调用本接口。', + 'type' => 'string', + 'required' => false, + 'example' => ' dtss0611o8vv90****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '设置是否限制实例变配', + 'description' => '- 本接口仅适用于经典版实例。'."\n" + .'- 数据迁移或同步任务完成后，您可以再次调用本接口，解除变配限制。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveSubInstance' => [ + 'summary' => '将子实例从分布式实例中移除并转变为普通实例（数据会被保留）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '分布式实例中的子实例ID，可调用[DescribeGlobalDistributeCache](~~473780~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '将子实例转换为普通实例', + 'description' => '> 完成转换后，子实例将转变为普通实例，您可以在对应地域的实例列表中找到该实例并进行管理。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'LockDBInstanceWrite' => [ + 'summary' => '锁定后，实例将仅支持读取数据，不支持写入。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'LockReason', + 'in' => 'query', + 'schema' => [ + 'description' => '锁定原因。', + 'type' => 'string', + 'required' => true, + 'example' => '锁写操作验证。', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', + ], + 'DBInstanceName' => [ + 'description' => '实例ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'r-2ev03avw0r0552***', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21986****', + ], + 'LockReason' => [ + 'description' => '锁定原因。', + 'type' => 'string', + 'example' => '锁定写操作测试。', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BE6E619-A657-42E3-AD2D-18F8428A****\\",\\n \\"DBInstanceName\\": \\"r-2ev03avw0r0552***\\",\\n \\"TaskId\\": 0,\\n \\"LockReason\\": \\"锁定写操作测试。\\"\\n}","type":"json"}]', + 'title' => '锁定实例写操作', + ], + 'UnlockDBInstanceWrite' => [ + 'summary' => '对写锁定的实例进行解锁，解锁后，实例支持读取、写入数据。', + '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' => '实例ID。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', + ], + 'DBInstanceName' => [ + 'description' => '实例名。', + 'type' => 'string', + 'example' => 'r-2ev03avw0r0552***', + ], + 'TaskId' => [ + 'description' => '任务ID。', + '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' => '解锁实例写锁定操作', + ], + 'RebootProxy' => [ + 'summary' => '重启运行中的云数据库 Tair（兼容 Redis）实例的代理节点。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1ymwrhvq79zj****', + ], + ], + [ + 'name' => 'ProxyList', + 'in' => 'query', + 'schema' => [ + 'description' => '进行操作的代理节点ID列表。逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '90310144,90310144', + ], + ], + [ + 'name' => 'RebootMode', + 'in' => 'query', + 'schema' => [ + 'description' => '操作类型，取值：'."\n" + ."\n" + .'- **reboot**：原地重启代理节点。'."\n" + ."\n" + .'- **rebuild**：重搭代理节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'reboot', + 'enum' => [ + 'reboot', + 'rebuild', + ], + ], + ], + [ + 'name' => 'ProxyNodeList', + 'in' => 'query', + 'schema' => [ + 'description' => '进行操作的代理节点所在主机ID列表。逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '36912280,36912282', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"561AFBF1-BE20-44DB-9BD1-6988B53E****\\"\\n}","type":"json"}]', + 'title' => '重启或重搭实例的代理节点', + 'description' => '仅支持实例为集群架构代理模式或读写分离架构。详细介绍，请参见[重启或重搭代理节点](~~164224~~)', + ], + 'UpgradeProxy' => [ + 'summary' => '升级集群版实例代理节点 proxy 到最新的版本。', + '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' => '实例id。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1vgja77wl7pb****', + ], + ], + [ + 'name' => 'ProxyInstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '要升级的代理节点id，使用英文小写逗号分隔。该参数仅对经典版实例有效。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'r-bp1vgja77wl7pb****-proxy-0', + ], + ], + [ + 'name' => 'SwitchTimeMode', + 'in' => 'query', + 'schema' => [ + 'description' => '变更规格的执行时间，取值：'."\n" + .'* **Immediately**：默认值，立即执行。'."\n" + .'* **MaintainTime**：实例可运维时间段内执行。'."\n" + ."\n" + .'> 您可以调用[ModifyInstanceMaintainTime](~~473775~~)修改Redis实例的可维护时间段。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => 'Immediately', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B830CDBB-91D9-5571-B6F4-35C76266****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B830CDBB-91D9-5571-B6F4-35C76266****\\"\\n}","type":"json"}]', + 'title' => '升级集群实例的数据库代理节点', + 'description' => '不同的架构在升级时所采取的流程和影响有所区别，详细介绍，请参见[小版本升级原理](~~56450~~)。'."\n" + ."\n" + .'> * 调用本接口前，您可以调用[DescribeEngineVersion](~~473781~~)查询实例代理节点当前的小版本。'."\n" + .'> * 升级会发生连接断开，请在业务低峰期进行升级，并确保应用程序具备重连机制，具体影响请参见[小版本升级原理](~~56450~~)。', + ], + 'ModifyInstanceNetExpireTime' => [ + 'summary' => '若云数据库 Tair（兼容 Redis）实例之前执行过由经典网络向VPC网络切换，并保留了经典网络连接地址，则可调用本接口延长经典网络连接地址的保留时间。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的经典网络连接地址。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'ClassicExpiredDays', + 'in' => 'query', + 'schema' => [ + 'description' => '延长经典网络连接地址的保留时间。取值：**14**、**30**、**60**或**120**，单位为天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '14', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9C4AF387-1EA3-4C84-8013-3F6B973EDDF5', + ], + 'NetInfoItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NetInfoItem' => [ + 'description' => '经典网络连接地址延长时间的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的经典网络信息列表。', + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'description' => '实例的服务端口。', + 'type' => 'string', + 'example' => '6379', + ], + 'DBInstanceNetType' => [ + 'description' => '网络类型，返回值为**Classic**（经典网络）。', + 'type' => 'string', + 'example' => 'Classic', + ], + 'ConnectionString' => [ + 'description' => '经典网络连接地址。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', + ], + 'ExpiredTime' => [ + 'description' => '经典网络地址的过期时间。', + 'type' => 'string', + 'example' => '2019-08-01T09:29:18Z', + ], + 'IPAddress' => [ + 'description' => '实例在经典网络中的IP地址。', + 'type' => 'string', + 'example' => '100.118.142.***', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '延长经典网络地址的保留时间', + 'description' => '该API对应的控制台操作请参见[修改原经典网络地址的使用期限](~~60062~~)。'."\n" + ."\n" + .'> 将实例从经典网络切换到VPC网络的方法请参见[SwitchNetwork](~~473797~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyDBInstanceConnectionString' => [ + 'summary' => '修改云数据库 Tair（兼容 Redis）实例的连接地址和端口。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'NewConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '新连接地址的前缀。实例的连接地址格式为：`<前缀>.redis.rds.aliyuncs.com`。地址前缀需由小写英文字母、数字组成，但必须以小写字母开头，长度为8~40个字符。'."\n" + .'> 请求参数**NewConnectionString**和**Port**两者中必须传入一项。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'standardredis123', + ], + ], + [ + 'name' => 'CurrentConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '实例当前的连接地址。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的服务端口号，取值范围：**1**~**65535**。'."\n" + .'> 请求参数**NewConnectionString**和**Port**两者中必须传入一项。', + 'type' => 'string', + 'required' => false, + 'example' => '6379', + 'maxLength' => 5, + 'minLength' => 1, + 'pattern' => '^\\d+$', + ], + ], + [ + 'name' => 'IPType', + 'in' => 'query', + 'schema' => [ + 'description' => '地址的网络类型，取值：'."\n" + .'* **Private**：专有网络。'."\n" + .'* **Public**：公网。', + 'type' => 'string', + 'required' => false, + 'example' => 'Public', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改实例的连接地址和端口', + 'description' => '该API对应的控制台操作请参见[修改连接地址](~~85683~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyIntranetAttribute' => [ + 'summary' => '临时调整专属集群中云数据库 Tair（兼容 Redis）实例的内网带宽。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'BandWidth', + 'in' => 'query', + 'schema' => [ + 'description' => '要增加的带宽，单位为MB/s。取值为大于等于0的整数。通常最大可传入当前实例规格默认最大带宽的2倍（规格对应带宽信息，请参见[实例规格查询导航](~~26350~~)），但是也存在下述限制：'."\n" + .'* 单实例的带宽不能超过所在主机的75%，主机规格及其带宽信息，请参见[主机规格详情](~~206343~~)。'."\n" + .'* 所在主机上所有实例的带宽总和不能超过所在主机的150%，您可以设置超配满足错峰部署的带宽使用。具体操作，请参见[设置集群超配降低成本](~~183798~~)。'."\n" + ."\n" + .'> 标准架构的实例如果不传入本参数，该实例的带宽会在当前带宽的基础上增加一倍。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据节点ID，您可以调用[DescribeClusterMemberInfo](~~473783~~)获取，传入多个时使用英文逗号（,）分隔。'."\n" + .'> 当实例为[集群架构](~~52228~~)时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****-db-0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '调整专属集群中实例的内网带宽', + 'description' => '> * 本接口仅适用于通过专属集群创建的实例，相关的控制台操作介绍及使用限制，请参见[修改带宽策略](~~206257~~)。如需调整普通实例的带宽，请调用[EnableAdditionalBandwidth](~~473771~~)接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeIntranetAttribute' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例当前的带宽。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AutoRenewal' => [ + 'description' => '购买的带宽是否开启了自动续订，取值：'."\n" + .'* **true**：已开启。'."\n" + .'* **false**：未开启。'."\n" + ."\n" + .'> 如果未购买带宽，则不返回本参数。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25D42CC3-FBA1-4AEC-BCE2-B8DD3137****', + ], + 'ExpireTime' => [ + 'description' => '临时带宽的过期时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 如果实例未执行过临时调整带宽或临时带宽已过期，本参数返回**0**。', + 'type' => 'string', + 'example' => '0', + ], + 'IntranetBandwidth' => [ + 'description' => '实例当前的内网带宽，本参数为实例中所有分片的带宽总和，单位MB/s。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '102', + ], + 'HasPrePaidBandWidthOrderRunning' => [ + 'description' => '实例是否有未到期的带宽包，取值：'."\n" + .'* **true**：存在未到期的带宽包。'."\n" + .'* **false**：不存在未到期的带宽包。'."\n" + .'> 如果实例未购买额外的带宽，则不返回本参数。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'BandwidthExpireTime' => [ + 'description' => '购买带宽的过期时间，格式为yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'> 如果实例未购买额外的带宽，则不返回本参数。', + 'type' => 'string', + 'example' => '2021-03-06T16:00:00Z', + ], + 'BandwidthPrePaid' => [ + 'description' => '带宽包付费类型，取值：'."\n" + .'- **0**：按量付费。'."\n" + .'- **1**：预付费。', + 'type' => 'string', + 'example' => '0', + ], + 'IntranetBandWidthBurst' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + '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' => '查询实例的带宽信息', + 'description' => '您可以调用[EnableAdditionalBandwidth](~~473771~~)接口为实例购买带宽。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SwitchNetwork' => [ + 'summary' => '切换云数据库 Tair（兼容 Redis）实例的专有网络VPC或交换机，如果实例为经典网络，则会将其切换为专有网络。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TargetNetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '需要切换到的网络类型，取值固定为**VPC**，即专有网络。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + 'default' => 'VPC', + 'enum' => [ + 'CLASSIC', + 'VPC', + ], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '要切换到的目标专有网络ID，可调用专有网络VPC的[DescribeVpcs](~~35739~~)获取。'."\n" + ."\n" + .'> * 目标专有网络所属的地域需和本实例相同。'."\n" + .'> * 传入本参数后，您还需要传入**VSwitchId**参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '要切换到的目标专有网络下的虚拟交换机ID，可调用专有网络VPC的[DescribeVpcs](~~35739~~)获取。'."\n" + .'> 目标虚拟交换机所属的可用区需和本实例相同。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'RetainClassic', + 'in' => 'query', + 'schema' => [ + 'description' => '如果实例当前为经典网络，将其切换至专有网络时，是否保留原经典网络连接地址，取值：'."\n" + .'* **True**：保留。'."\n" + .'* **False**：默认值，不保留。'."\n" + ."\n" + .'> 当实例的网络类型为经典网络时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'True', + ], + ], + [ + 'name' => 'ClassicExpiredDays', + 'in' => 'query', + 'schema' => [ + 'description' => '经典网络连接地址的保留时间，取值：**14**、**30**、**60**、**120**，单位为天。'."\n" + ."\n" + .'> * 当**RetainClassic**取值为**True**，本参数才可用且必须传入。'."\n" + .'> * 完成切换后，您还可以调用[ModifyInstanceNetExpireTime](~~473793~~)修改经典网络连接地址的保留时间。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + 'pattern' => '^\\d+$', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '578678678', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F0997EE8-F4C2-4503-9168-85177ED78C70', + ], + ], + ], + ], + ], + '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' => '切换专有网络VPC或交换机', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AllocateInstancePublicConnection' => [ + 'summary' => '为云数据库 Tair（兼容 Redis）实例申请公网连接地址。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '公网连接地址的前缀，需由小写英文字母与数字组成，以小写字母开头，长度为8~40个字符。'."\n" + .'> 公网连接地址格式为：`<前缀>.redis.rds.aliyuncs.com`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的服务端口号，取值范围：**1024**~**65535**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '6379', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '为实例申请公网连接地址', + 'description' => '该API对应的控制台操作请参见[申请公网连接地址](~~124920~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ReleaseInstancePublicConnection' => [ + 'summary' => '释放云数据库 Tair（兼容 Redis）实例的公网连接地址。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'CurrentConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '待释放的公网连接地址。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '88F850B5-CC68-48B4-83CA-5497C3C191DE', + ], + ], + ], + ], + ], + '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' => '释放公网连接地址', + 'description' => '该API对应的控制台操作请参见[释放外网连接地址](~~125424~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AllocateDirectConnection' => [ + 'summary' => '申请云数据库 Tair（兼容 Redis）集群实例的直连地址。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => '直连地址的前缀，由小写英文字母或数字组成，以小写字母开头，长度为8~40字符。默认为实例ID+`-direct`，例如实例ID为r-8vbwsicr5d5gse****，则该参数默认为`r-8vbwsicr5d5gse****-direct`。', + 'type' => 'string', + 'required' => false, + 'example' => 'redisdirect123', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号，取值范围为**1024**~**65535**，默认值为**6379**。', + 'type' => 'string', + 'required' => false, + 'example' => '6379', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '申请集群实例的直连地址', + 'description' => '客户端可通过直连地址绕过代理，像连接原生Redis集群一样连接集群实例，从而降低链路开销，进一步提升云数据库 Tair（兼容 Redis）服务的响应速度。'."\n" + ."\n" + .'调用本接口的实例需满足下述条件：'."\n" + .'* 实例为集群架构。'."\n" + .'* 部署模式为经典。'."\n" + .'* 实例的网络类型为专有网络。如果当前为经典网络，您可以调用[SwitchNetwork](~~473797~~)接口将其切换为专有网络。'."\n" + .'* 实例未开启SSL加密功能。如果已开启SSL加密功能，您可以调用[ModifyInstanceSSL](~~473838~~)接口将其关闭。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ReleaseDirectConnection' => [ + 'summary' => '释放云数据库 Tair（兼容 Redis）集群实例的直连地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '释放集群实例的直连地址', + 'description' => '客户端可通过直连地址绕过代理，像连接原生Redis集群一样连接云数据库 Tair（兼容 Redis）集群，从而降低链路开销，进一步提升实例的响应速度。更多信息，请参见[开通直连访问](~~146901~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SwitchInstanceProxy' => [ + 'summary' => '开启或关闭专属集群中云数据库 Tair（兼容 Redis）集群实例的代理模式。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '开启或关闭集群实例的代理模式', + 'description' => '关于代理模式的详细介绍，请参见[Proxy特性说明](~~142959~~)。'."\n" + .'调用本接口时，需满足下述条件：'."\n" + .'* 实例是通过专属集群创建的，更多信息，请参见[云数据库专属集群MyBase](~~141455~~)。'."\n" + .'* 实例为[集群架构](~~52228~~)。'."\n" + ."\n" + .'> 调用本接口前，您需要调用[DescribeDedicatedClusterInstanceList](~~473867~~)接口，通过返回参数**ProxyCount**的值来判断当前实例是否开启了代理模式。例如，返回值为0时，表示未开启代理模式；返回值大于0时，即表示已开启代理模式。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyInstanceAutoRenewalAttribute' => [ + 'summary' => '开启或者关闭云数据库 Tair（兼容 Redis）实例的到期前自动续费功能。', + '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' => '实例ID。多个实例ID用英文逗号（,）分隔。'."\n" + .'> 最多允许传入30个实例ID。 ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费周期，取值范围为**1**~**12**，单位为月。实例即将到期时，系统将自动地以选择的续费时长进行续费。'."\n" + .'> 当**AutoRenew**参数取值为**true**时，本参数才可用且必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '开启或关闭自动续费，取值：'."\n" + .'* **true**：开启。'."\n" + .'* **false**。关闭。'."\n" + ."\n" + .'> 默认值：**false**。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'False', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '产品，固定为kvstore。', + 'type' => 'string', + 'required' => false, + 'example' => 'kvstore', + 'default' => 'kvstore', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '52D901ED-E0A5-42FB-B9DB-39C295C3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52D901ED-E0A5-42FB-B9DB-39C295C3****\\"\\n}","type":"json"}]', + 'title' => '开启或关闭实例自动续费', + 'description' => '> 自动续费将于实例到期前7天触发。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePrice' => [ + 'summary' => '查询创建、升级配置或续费云数据库 Tair（兼容 Redis）实例等操作产生的费用。', + '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' => '地域ID，可调用[DescribeRegions](~~473763~~)查询。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Capacity', + 'in' => 'query', + 'schema' => [ + 'description' => '使用实例的存储容量指定规格，单位为MB。本参数仅查询Redis开源版经典部署模式的实例，推荐您使用**InstanceClass**参数精确地指定一个规格。'."\n" + .'> 指定**InstanceClass**参数后，无需再指定本参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1024', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '使用**InstanceClass**编码指定实例规格。**InstanceClass**查询步骤：'."\n" + .'1. 在[规格查询导航](~~26350~~)中，根据需要选择实例类型，点击其**架构类型**列以打开规格文档。'."\n" + .'2. 在规格文档的实例规格表中，选择需要的实例规格，并找到其**InstanceClass**列的编码。'."\n" + ."\n" + .'> 以查询新购场景为例，除其他关键参数以外，您至少需要传入如下参数：'."\n" + .'> * 查询经典版实例：请传入本参数。'."\n" + .'> * 查询云原生版标准架构实例：请传入本参数。'."\n" + .'> * 查询云原生版集群架构实例：请传入本参数与**ShardCount**参数。'."\n" + .'> * 查询云原生版读写分离架构实例：请传入本参数，并传入**Instances**参数。'."\n" + .'> * 查询多个不同规格的实例，或需查询Tair ESSD型实例（自定义存储类型和存储空间）：请传入Instances参数（无需传入本参数）。', + 'type' => 'string', + 'required' => false, + 'example' => 'redis.master.small.default', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型，取值：'."\n" + .'* **BUY**：新购。'."\n" + .'* **UPGRADE**：变更配置。'."\n" + .'* **RENEW**：续费。'."\n" + .'* **CONVERT**：转换付费类型。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'BUY', + 'enum' => [ + 'BUY', + 'UPGRADE', + 'DOWNGRADE', + 'RENEW', + 'CONVERT', + ], + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID，可调用[DescribeZones](~~473764~~)查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-e', + ], + ], + [ + 'name' => 'SecondaryZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '备可用区ID，可调用[DescribeZones](~~473764~~)接口查询。'."\n" + .'> 本参数和ZoneId参数传入的值不能相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-g', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '付费类型，取值：'."\n" + .'* **PostPaid**（默认）：按量付费。'."\n" + .'* **PrePaid**：包年包月。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'default' => 'PostPaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型，取值：'."\n" + .'- **STAND_ALONE**：单副本。'."\n" + .'- **MASTER_SLAVE**（默认）：高可用（双副本）。', + 'type' => 'string', + 'required' => false, + 'example' => 'MASTER_SLAVE', + 'default' => 'MASTER_SLAVE', + 'enum' => [ + 'STAND_ALONE', + 'MASTER_SLAVE', + ], + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '包年包月时长，单位为月。取值范围：**1**~**9**、**12**、**24**、**36**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Quantity', + 'in' => 'query', + 'schema' => [ + 'description' => '购买实例的数量，取值范围：**1**~**30**，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + .'> 当**OrderType**为**UPGRADE**或**RENEW**时必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'schema' => [ + 'description' => '当您需要查询云原生版读写分离架构、Tair ESSD型实例或多个不同规格的实例时，需要传入本参数，为JSON格式字符串，更多信息请参见下方的**Instances参数补充说明**。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"RegionId": "cn-hangzhou","ZoneId": "cn-hangzhou-b","ShardClass": "tair.scm.with.proxy.standard.2m.8d","ShardCount": "3","Period": "1","Quantity": "1"}]', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '活动ID、业务信息等扩展信息。', + 'type' => 'string', + 'required' => false, + 'example' => '000000000000', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠码，默认值：youhuiquan_promotion_option_id_for_blank，表示无优惠码。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'default' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'ForceUpgrade', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制变配，取值：'."\n" + .'* **false**：是。'."\n" + .'* **true**（默认）：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'OrderParamOut', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回订单参数，可选值：'."\n" + .'* **false**（默认）：不返回。'."\n" + .'* **true**：返回。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'ShardCount', + 'in' => 'query', + 'schema' => [ + 'description' => '云原生集群实例中的数据分片节点的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Redis实例的引擎版本，取值：**2.8**、**4.0**、**5.0**或**6.0**。'."\n" + ."\n" + .'Redis实例的引擎版本，取值：**2.8**、**4.0**或**5.0**。'."\n" + ."\n" + .'Redis实例的引擎版本，取值：**2.8**、**4.0**或**5.0**。', + 'type' => 'string', + 'required' => false, + 'example' => '5.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderParams' => [ + 'description' => '订单参数，当OrderParamOut为`true`时返回。', + 'type' => 'string', + 'example' => 'String', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3A40BE4E-1890-4972-889C-FEFA37663635', + ], + 'Order' => [ + 'description' => '订单信息。', + 'type' => 'object', + 'properties' => [ + 'OriginalAmount' => [ + 'description' => '订单原价。', + 'type' => 'string', + 'example' => '0.21', + ], + 'HandlingFeeAmount' => [ + 'description' => '手续费。', + 'type' => 'string', + 'example' => '0.1', + ], + 'Currency' => [ + 'description' => '币种，中国站为CNY（人民币）；国际站为USD（美元）。', + 'type' => 'string', + 'example' => 'CNY', + ], + 'DiscountAmount' => [ + 'description' => '订单优惠金额。', + 'type' => 'string', + 'example' => '0.21', + ], + 'TradeAmount' => [ + 'description' => '订单实际交易价。', + 'type' => 'string', + 'example' => '10', + ], + 'Coupons' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Coupon' => [ + 'description' => '优惠券信息。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠券信息。', + 'type' => 'object', + 'properties' => [ + 'IsSelected' => [ + 'description' => '是否选中该优惠券。', + 'type' => 'string', + 'example' => 'true', + ], + 'CouponNo' => [ + 'description' => '优惠券编码。', + 'type' => 'string', + 'example' => 'youhuiquan_promotion_option_id_for_blank', + ], + 'Name' => [ + 'description' => '优惠券名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'description' => '优惠券描述。', + 'type' => 'string', + 'example' => 'coupondemo', + ], + ], + ], + ], + ], + ], + 'RuleIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleId' => [ + 'description' => '活动ID。', + 'type' => 'array', + 'items' => [ + 'description' => '活动ID。', + 'type' => 'string', + 'example' => '[202]', + ], + ], + ], + ], + 'ShowDiscountInfo' => [ + 'description' => '是否展示折扣信息。', + 'type' => 'boolean', + ], + 'DepreciateInfo' => [ + 'description' => '活动信息。', + 'type' => 'object', + 'properties' => [ + 'ListPrice' => [ + 'description' => '目录价。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1*', + ], + 'OriginalStandAmount' => [ + 'description' => '原始官网总价。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12*', + ], + 'CheapStandAmount' => [ + 'description' => '降价后官网总价。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9*', + ], + 'CheapRate' => [ + 'description' => '降价比例。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30%', + ], + 'Differential' => [ + 'description' => '差价优惠（订单总价展示）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '**', + ], + 'DifferentialName' => [ + 'description' => '差价优惠名称。', + 'type' => 'string', + 'example' => 'XXXXX', + ], + 'MonthPrice' => [ + 'description' => '折合月价。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '**', + ], + 'IsContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'IsShow' => [ + 'description' => '是否展示降价幅度。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ContractActivity' => [ + 'description' => '活动信息。', + 'type' => 'object', + 'properties' => [ + 'FinalPromFee' => [ + 'description' => '优惠总费用。', + 'type' => 'number', + 'format' => 'double', + 'example' => "\n", + ], + 'FinalFee' => [ + 'description' => '优惠后费用。', + 'type' => 'number', + 'format' => 'double', + 'example' => "\n", + ], + 'ProdFee' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '****', + ], + 'ActivityId' => [ + 'description' => '活动ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****', + ], + 'OptionCode' => [ + 'description' => '优惠ID。', + 'type' => 'string', + 'example' => '****', + ], + 'ActivityName' => [ + 'description' => '活动名称。', + 'type' => 'string', + 'example' => '合同优惠_整单_xxx折', + ], + 'OptionIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OptionId' => [ + 'description' => '优惠ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '*****', + ], + ], + ], + ], + ], + ], + ], + ], + 'StandDiscountPrice' => [ + 'description' => '折扣价格。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****', + ], + 'IsContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => 'false'."\n", + ], + 'StandPrice' => [ + 'description' => '折扣价。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0'."\n", + ], + 'Code' => [ + 'description' => '订单码。', + 'type' => 'string', + 'example' => '""'."\n", + ], + 'Message' => [ + 'description' => '订单信息。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + 'Rules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Rule' => [ + 'description' => '活动规格。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RuleDescId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111111111', + ], + 'Title' => [ + 'description' => '策略标题。', + 'type' => 'string', + 'example' => 'test', + ], + 'Name' => [ + 'description' => '活动名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + 'SubOrders' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SubOrder' => [ + 'description' => '优惠券对应的策略。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OriginalAmount' => [ + 'description' => '订单原价。', + 'type' => 'string', + 'example' => '0.21', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1xxxxxxxxxxxxx', + ], + 'DiscountAmount' => [ + 'description' => '订单优惠金额。', + 'type' => 'string', + 'example' => '0.21', + ], + 'TradeAmount' => [ + 'description' => '订单实际交易价。', + 'type' => 'string', + 'example' => '10', + ], + 'RuleIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleId' => [ + 'description' => '活动ID。', + 'type' => 'array', + 'items' => [ + 'description' => '命中策略的ID。', + 'type' => 'string', + 'example' => 'RuleId: 1111111111', + ], + ], + ], + ], + 'OptionalPromotions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OptionalPromotion' => [ + 'description' => '可选择的优惠选项列表结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Selected' => [ + 'description' => '是否外部选中。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CouponNo' => [ + 'description' => '是否使用优惠券，取值说明：'."\n" + ."\n" + .'- default或null（默认）：使用优惠券。'."\n" + .'- youhuiquan_promotion_option_id_for_blank：不使用优惠券。', + 'type' => 'string', + 'example' => 'default', + ], + 'Name' => [ + 'description' => '优惠券名称。', + 'type' => 'string', + 'example' => '****', + ], + 'Description' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '****', + ], + 'Show' => [ + 'description' => '优惠是否展示。', + 'type' => 'boolean', + 'example' => 'False', + ], + 'ActivityExtInfo' => [ + 'description' => '活动额外信息。', + 'type' => 'object', + 'example' => '****', + ], + 'OptionCode' => [ + 'description' => '活动额外信息。', + 'type' => 'string', + 'example' => '****', + ], + 'PromotionName' => [ + 'description' => '优惠名称。', + 'type' => 'string', + 'example' => '****', + ], + 'PromotionOptionNo' => [ + 'description' => '优惠号。', + 'type' => 'string', + 'example' => 'youhuiquan_promotion_option_id_for_blank', + ], + 'CanPromFee' => [ + 'description' => '可优惠价格。', + 'type' => 'string', + 'example' => '****', + ], + ], + ], + ], + ], + ], + 'DepreciateInfo' => [ + 'description' => '降价信息。', + 'type' => 'object', + 'properties' => [ + 'ListPrice' => [ + 'description' => '目录价。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****', + ], + 'OriginalStandAmount' => [ + 'description' => '原始官网总价。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****', + ], + 'CheapStandAmount' => [ + 'description' => '降价后官网总价。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****', + ], + 'CheapRate' => [ + 'description' => '降价比例。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****', + ], + 'Differential' => [ + 'description' => '差价优惠（订单总价展示）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****', + ], + 'DifferentialName' => [ + 'description' => '差价优惠名称。', + 'type' => 'string', + 'example' => '****', + ], + 'MonthPrice' => [ + 'description' => '折合月价。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****', + ], + 'IsContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ContractActivity' => [ + 'description' => '合同优惠。', + 'type' => 'object', + 'properties' => [ + 'FinalPromFee' => [ + 'description' => '优惠总费用。', + 'type' => 'number', + 'format' => 'double', + 'example' => '****', + ], + 'FinalFee' => [ + 'description' => '优惠后费用。', + 'type' => 'number', + 'format' => 'double', + 'example' => '****', + ], + 'ProdFee' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '****', + ], + 'ActivityId' => [ + 'description' => '活动id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1412025702634847', + ], + 'OptionCode' => [ + 'description' => '优惠id。', + 'type' => 'string', + 'example' => '****', + ], + 'ActivityName' => [ + 'description' => '活动名称。', + 'type' => 'string', + 'example' => '****', + ], + 'OptionIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OptionId' => [ + 'description' => '优惠ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => "\n", + ], + ], + ], + ], + ], + ], + 'StartTime' => [ + 'description' => '活动开始时间。', + 'type' => 'string', + 'example' => '2024-11-18T00:00:00Z', + ], + ], + ], + 'StandDiscountPrice' => [ + 'description' => '折扣价格。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****', + ], + 'IsContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => '****', + ], + 'StandPrice' => [ + 'description' => '折扣价。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****', + ], + 'ModuleInstance' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ModuleInstance' => [ + 'description' => '订单行实例配置。', + 'type' => 'array', + 'items' => [ + 'description' => '订单行实例配置子对象。', + 'type' => 'object', + 'properties' => [ + 'ModuleCode' => [ + 'description' => '模块code。', + 'type' => 'string', + 'example' => '****', + ], + 'ModuleId' => [ + 'description' => '模块Id。', + 'type' => 'string', + 'example' => '****', + ], + 'StandPrice' => [ + 'description' => '折扣价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '****', + ], + 'PricingModule' => [ + 'description' => '是否计价项。', + 'type' => 'boolean', + 'example' => '****', + ], + 'ModuleName' => [ + 'description' => '模块名称。', + 'type' => 'string', + 'example' => '****', + ], + 'DiscountFee' => [ + 'description' => '折扣费用。', + 'type' => 'number', + 'format' => 'double', + 'example' => '****', + ], + 'TotalProductFee' => [ + 'description' => '产品原价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0'."\n", + ], + 'NeedOrderPay' => [ + 'description' => '在订单中是否需要支付。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PayFee' => [ + 'description' => '实付金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0'."\n", + ], + 'ModuleAttrs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'moduleAttr' => [ + 'description' => '模块属性。', + 'type' => 'array', + 'items' => [ + 'description' => '订购参数。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '属性类型。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****', + ], + 'Value' => [ + 'description' => '属性类型。', + 'type' => 'string', + 'example' => '****', + ], + 'Code' => [ + 'description' => '属性代码。', + 'type' => 'string', + 'example' => '****', + ], + 'Name' => [ + 'description' => '属性名称。', + 'type' => 'string', + 'example' => '****', + ], + ], + ], + ], + ], + ], + 'ContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => '****', + ], + 'DepreciateInfo' => [ + 'description' => '降价信息。', + 'type' => 'object', + 'properties' => [ + 'ListPrice' => [ + 'description' => '目录价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '****', + ], + 'OriginalStandAmount' => [ + 'description' => '原始官网总价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '****', + ], + 'CheapStandAmount' => [ + 'description' => '降价后官网总价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '****', + ], + 'CheapRate' => [ + 'description' => '降价比例。', + 'type' => 'number', + 'format' => 'double', + 'example' => '******', + ], + 'Differential' => [ + 'description' => '差价优惠（订单总价展示）。', + 'type' => 'number', + 'format' => 'double', + 'example' => '****', + ], + 'DifferentialName' => [ + 'description' => '差价优惠名称。', + 'type' => 'string', + 'example' => '****', + ], + 'MonthPrice' => [ + 'description' => '折合月价。', + 'type' => 'number', + 'format' => 'double', + 'example' => '****', + ], + 'IsContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => '****', + ], + 'IsShow' => [ + 'description' => '是否展示降价幅度。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StartTime' => [ + 'description' => '活动开始时间。', + 'type' => 'string', + 'example' => '2024-09-23T14:00:01Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'PromDetailList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PromDetail' => [ + 'description' => '优惠明细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '优惠信息。', + 'type' => 'object', + 'properties' => [ + 'PromotionName' => [ + 'description' => '优惠活动名称。', + 'type' => 'string', + 'example' => '****', + ], + 'PromotionId' => [ + 'description' => '优惠ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****', + ], + 'FinalPromFee' => [ + 'description' => '优惠金额。', + 'type' => 'number', + 'format' => 'double', + 'example' => '****', + ], + 'OptionCode' => [ + 'description' => '优惠券代号。', + 'type' => 'string', + 'example' => '****', + ], + 'PromType' => [ + 'description' => '优惠子类型。', + 'type' => 'string', + 'example' => '****', + ], + 'ActivityExtInfo' => [ + 'description' => '活动额外信息。', + 'type' => 'object', + 'example' => '****', + ], + 'DerivedPromType' => [ + 'description' => '优惠子类型。', + 'type' => 'string', + 'example' => '****', + ], + 'PromotionCode' => [ + 'description' => '优惠码。', + 'type' => 'string', + 'example' => '****', + ], + ], + ], + ], + ], + ], + 'ContractActivity' => [ + 'description' => '命中合同优惠。', + 'type' => 'boolean', + 'example' => '****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询价格', + 'requestParamsDescription' => '### Instances参数补充说明'."\n" + .'以下说明仅适用于DescribePrice接口Instances参数的补充说明，不适用于其它接口。'."\n" + .''."\n" + .''."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .''."\n" + .''."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .''."\n" + .'
名称类型是否必选示例值描述
RegionIdString是cn-hangzhou地域 ID。
InstanceIdString否r-7xv4s7q131smyx****实例ID，当OrderType为UPGRADE或RENEW时必传。
InstanceClassString是redis.master.small.default经典版实例的实例规格，请参见规格查询导航。
ShardClassString是tair.rdb.2g云原生版实例的实例规格，请参见规格查询导航。
本参数和 InstanceClass 两者中必须传入一项。
IzNoString否cn-hangzhou-b可用区ID。
NodeTypeString否MASTER_SLAVE节点类型，取值：
  • STAND_ALONE：单副本。
  • MASTER_SLAVE（默认）：高可用（双副本）。
PeriodLong否1包年包月时长，单位为月。取值范围：1~9、12、24、36。
QuantityString否1购买实例的数量，取值范围：1~30。默认值：1。
VPCIdString否vpc-bp1nme44gek34slfc****VPC ID。
VSwitchIdString否vsw-bp1e7clcw529l773d****虚拟交换机ID。
AutoPayString否true是否自动付款，取值：
  • true（默认）：是
  • false：否
InstanceNameString否test_123实例名称。
ShardCountString否2分片节点数，默认为1，查询标准架构、读写分离架构实例时无需传入该参数。本参数仅适用于查询云原生版集群架构实例，您可以通过该参数实现自定义分片数量。
ReadOnlyCountInteger否2总只读节点数量，本参数仅适用于创建云原生版读写分离架构实例。
StorageTypeString否essd_pl2Tair ESSD磁盘型的存储类型，取值为essd_pl0、essd_pl1、essd_pl2和essd_pl3，在指定本参数时，您还需同时指定Capacity为自定义磁盘容量。更多信息请参见磁盘型实例规格。
CapacityLong否512000Tair ESSD磁盘型的磁盘容量，单位：MB。
'."\n" + ."\n" + .'### 参数请求示例'."\n" + .'查询新购Tair云原生版集群架构的示例（该场景无需传入**Instances**参数）：'."\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" + .'查询新购Tair ESSD磁盘型自定义存储类型的示例：'."\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" + .'查询新购Tair云原生版读写分离架构的示例：'."\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" + .'
{'."\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" + .'查询续费Tair云原生版集群架构的示例（该场景无需传入**Instances**参数）：'."\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' => '查看云数据库 Tair（兼容 Redis）实例是否开通自动续费。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的ID。'."\n" + .'> 默认查询所有实例是否开通自动续费。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：**30**、**50**、**100**。'."\n" + .'> 默认值：**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于**0**且不超过Integer的最大值，默认值：**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2B17D708-1D6D-49F3-B6D7-478371DD****', + ], + 'PageNumber' => [ + 'description' => '当前显示的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageRecordCount' => [ + 'description' => '当前页显示的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Item' => [ + 'description' => '实例的自动续费信息组成的集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'description' => '续费周期，单位为月。 ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'AutoRenew' => [ + 'description' => '自动续费状态，返回值：'."\n" + .'* **true**：已开启。'."\n" + .'* **false**：未开启。 ', + 'type' => 'string', + 'example' => 'true', + ], + 'RegionId' => [ + 'description' => '地域ID。', + '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' => '查询实例是否开通自动续费', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RenewAdditionalBandwidth' => [ + 'summary' => '云数据库 Tair（兼容 Redis）实例的带宽已升级为按量付费模式，不再推荐使用本接口。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠券编号。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'default' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费。取值：'."\n" + ."\n" + .'* **true**：自动付费，默认值。'."\n" + .'* **false**：手动付费。您需要在控制台的顶部菜单栏，单击**费用** > **续费管理**，然后单击左侧导航栏的**订单管理** > **我的订单**，找到目标订单进行支付。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'OrderTimeLength', + 'in' => 'query', + 'schema' => [ + 'description' => '购买的时长，单位为天，取值：**1**、**2**、**3**、**7**、**14**、**30**、**60**、**90**、**180**、**365**、**730**、**1095**、**1825**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '30', + 'default' => '', + ], + ], + [ + 'name' => 'SourceBiz', + 'in' => 'query', + 'schema' => [ + 'description' => '调用来源，本参数仅用于内部维护使用，无需传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'SDK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '2084452111111', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '带宽续费', + 'description' => '不再推荐使用本接口，您可以通过控制台（[调整实例带宽](~~102588~~)）或调用[EnableAdditionalBandwidth](~~473771~~)购买实例的带宽。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TransformInstanceChargeType' => [ + 'summary' => '转换云数据库 Tair（兼容 Redis）实例的付费类型，支持按量付费和包年包月付费类型之间的相互转换。', + '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' => '实例ID，您可以调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '包年包月的付费时长，单位为月，取值：**1**~**9**、**12**、**24**、**36**。'."\n" + .'> 当**ChargeType**参数取值为**PrePaid**时，本参数才可用且必须传入。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费，取值：'."\n" + ."\n" + .'* **true**：自动付费，默认值。'."\n" + .'* **false**：手动付费。您需要在控制台的顶部菜单栏，单击**费用** > **续费管理**，然后单击左侧导航栏的**订单管理** > **我的订单**，找到目标订单进行支付。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '要转换到的付费类型，取值：'."\n" + .'* **PrePaid**：包年包月，传入本值时，您还需要传入**Period**参数。'."\n" + .'* **PostPaid**：按量付费。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PrePaid', + 'default' => '', + 'enum' => [ + 'PostPaid', + 'PrePaid', + 'POSTPAID', + 'PREPAID', + 'PREPAY', + 'POSTPAY', + ], + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费，取值：'."\n" + .'* **true**：开启。'."\n" + .'* **false**（默认）：不开启。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'false' => '关闭', + 'true' => '开启', + ], + 'example' => 'false', + 'default' => 'false', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费周期，单位为月，取值：**1**、**2**、**3**、**6**、**12**。'."\n" + ."\n" + .'> 当**AutoRenew**取值为**true**时，本参数必须传入。', + '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' => '实例的到期时间。'."\n" + .'> 当实例的付费类型从按量付费转换为包年包月时，本参数才会返回具体的值。', + 'type' => 'string', + 'example' => '2021-05-13T00:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '82C791FB-8979-489E-853D-706D7743****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + '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' => '转换付费类型', + 'description' => '请确保在调用本接口前，您已了解相关注意事项和费用说明，更多信息，请参见：'."\n" + .'* [从按量付费转换为包年包月](~~54542~~)。'."\n" + .'* [从包年包月转换为按量付费](~~211549~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RenewInstance' => [ + 'summary' => '为包年包月的云数据库 Tair（兼容 Redis）实例续费。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Capacity', + 'in' => 'query', + 'schema' => [ + 'description' => '续费不允许变更存储容量，该参数已经弃用，默认按当前规格下订单续费。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '续费不允许变更规格，该参数已经弃用，默认按当前规格下订单续费。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '续费的周期，单位为月，取值：**1**~**9**、**12**、**24**、**36**。'."\n" + .'>例如实例还有3个月到期，本次续费3个月，则本次续费后，实例还剩余6个月到期。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动付费。取值：'."\n" + ."\n" + .'* **true**：自动付费，默认值。'."\n" + .'* **false**：手动付费。'."\n" + ."\n" + .'选择为手动付费时，您需要在控制台的顶部菜单栏，单击**费用** > **续费管理**，然后单击左侧导航栏的**订单管理** > **我的订单**，找到目标订单进行支付。'."\n" + ."\n" + .'选择为手动付费时，您需要在控制台的顶部菜单栏，单击**费用** > **续费管理**，然后单击左侧导航栏的**订单管理**，找到目标订单进行支付。'."\n" + ."\n\n" + ."\n" + .'选择为手动付费时，您需要在控制台的顶部菜单栏，单击**费用** > **续费管理**，然后单击左侧导航栏的**订单管理**，找到目标订单进行支付。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'FromApp', + 'in' => 'query', + 'schema' => [ + 'description' => '用于备注请求来源，默认值为**OpenAPI**，无需手动设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI', + 'default' => 'OpenApi', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '活动ID、业务信息。', + 'type' => 'string', + 'required' => false, + 'example' => '000000000', + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠码，默认值为：`youhuiquan_promotion_option_id_for_blank`。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'default' => 'youhuiquan_promotion_option_id_for_blank', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => '0.6823317918435086', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费，取值：'."\n" + .'* **true**：开启，按以选择的续费时长进行续费，例如您选择续费时长为3个月，那么每次自动续费时会缴纳3个月的费用。'."\n" + .'* **false**（默认）：不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '订单结束时间。', + 'type' => 'string', + 'example' => '2019-02-19T00:00:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2222245-222A-4155-9349-E22222****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + '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' => '手动续费', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAccount' => [ + 'summary' => '创建云数据库 Tair（兼容 Redis）实例的账号。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名，需满足以下条件：'."\n" + .'* 以英文字母开头，由小写英文字母、数字或下划线（_）组成。'."\n" + .'* 长度不超过100个字符。'."\n" + .'* 不能为[Redis账号名保留字](https://help.aliyun.com/zh/redis/user-guide/create-and-manage-database-accounts#section-u3q-817-om3)[Redis账号名保留字](https://www.alibabacloud.com/help/zh/redis/user-guide/create-and-manage-database-accounts#section-u3q-817-om3)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'demoaccount', + ], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => [ + 'description' => '账号权限，取值：'."\n" + .'* **RoleReadOnly**：只读权限。'."\n" + .'* **RoleReadWrite**：读写权限，默认值。', + 'type' => 'string', + 'required' => false, + 'example' => 'RoleReadOnly', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '账号的密码。长度为8~32位，需包含大写字母、小写字母、特殊字符和数字中的至少三种，允许的特殊字符包括`!@#$%^&*()_+-=`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'uWonno21****', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '账号描述。'."\n" + .'* 需以中文、英文字母开头，不能以`http: //`或`https: //`开头。'."\n" + .'* 可以包含中文、英文字母、数字、下划线（_）和短划线（-）。 '."\n" + .'* 长度为2~256个字符。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'testaccount', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '账号类型，取值固定为**Normal**（普通账号）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'SourceBiz', + 'in' => 'query', + 'schema' => [ + 'description' => '本参数仅用于内部维护，无需传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'SDK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ABAF95F6-35C1-4177-AF3A-70969EBD****', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'AcountName' => [ + 'description' => '本参数已废弃。', + 'type' => 'string', + 'example' => 'demoaccount', + ], + 'AccountName' => [ + 'title' => '', + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'demoaccount', + ], + ], + ], + ], + ], + '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' => '创建账号', + 'description' => '* 该API仅支持兼容Redis 4.0及以上版本的实例；'."\n" + .' * 使用该API需要实例状态为运行中； '."\n" + .' * 一个实例下最多可创建18个账号。'."\n" + .'> 该API对应的控制台操作请参见[账号管理](~~92665~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteAccount' => [ + 'summary' => '删除云数据库 Tair（兼容 Redis）实例的账号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '56365', + 'abilityTreeNodes' => [ + 'FEATUREkvstoreXSBQ72', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名，您可以调用[DescribeAccounts](~~473816~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'demoaccount', + ], + ], + [ + 'name' => 'SourceBiz', + 'in' => 'query', + 'schema' => [ + 'description' => '本参数仅用于内部维护使用，无需传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'SDK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '删除账号', + 'description' => '* 该API仅支持兼容Redis 4.0及以上版本的实例；'."\n" + .'* 实例的状态为运行中时才能调用该API。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAccountDescription' => [ + 'summary' => '修改云数据库 Tair（兼容 Redis）实例的账号描述。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名，您可以调用[DescribeAccounts](~~473816~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'demoaccount', + ], + ], + [ + 'name' => 'AccountDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '要设置的账号描述。'."\n" + .'* 以中文、英文字母开头，不能以`http://`或`https://`开头。'."\n" + .'* 可以包含中文、英文字母、数字、下划线（_）和短横线。'."\n" + .'* 长度为2~256个字符。 ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testescription', + ], + ], + [ + 'name' => 'SourceBiz', + 'in' => 'query', + 'schema' => [ + 'description' => '本参数仅用于内部维护使用，无需传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'SDK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改账号的描述', + 'description' => '该API仅支持兼容Redis 4.0及以上版本的实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAccountPassword' => [ + 'summary' => '修改云数据库 Tair（兼容 Redis）实例中指定账号的密码。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '待修改密码的账号名，您可以调用[DescribeAccounts](~~473816~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testaccount', + ], + ], + [ + 'name' => 'OldAccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '该账号的原密码。'."\n" + ."\n" + .'> 如果忘记账号的密码，您也可以调用[ResetAccountPassword](~~473815~~)接口重置密码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oldPassWd999****', + ], + ], + [ + 'name' => 'NewAccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '该账号要设置的新密码。密码长度为8~32位，需包含大写字母、小写字母、数字、特殊字符中的至少三种，特殊字符为`!@#$%^&*()_+-=`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'newPassWd888****', + ], + ], + [ + 'name' => 'SourceBiz', + 'in' => 'query', + 'schema' => [ + 'description' => '本参数仅用于内部维护使用，无需传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'SDK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改账号密码', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAccounts' => [ + 'summary' => '查找指定云数据库 Tair（兼容 Redis）实例列表中某个账号的信息。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的账号名。', + 'type' => 'string', + 'required' => false, + 'example' => 'demoaccount', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6C9E114C-217C-4118-83C0-B4070222****', + ], + 'Accounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Account' => [ + 'description' => '实例的账号信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '账号信息详情。', + 'type' => 'object', + 'properties' => [ + 'AccountDescription' => [ + 'description' => '账号备注信息。', + 'type' => 'string', + 'example' => 'testdec', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp10noxlhcoim2****', + ], + 'AccountType' => [ + 'description' => '账号类型，返回值：'."\n" + .'* **Normal**：普通账号。'."\n" + .'* **Super**：超级账号。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'AccountStatus' => [ + 'description' => '账号状态，返回值：'."\n" + .'* **Unavailable**：不可用。'."\n" + .'* **Available**：可用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'AccountName' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'demoaccount', + ], + 'DatabasePrivileges' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DatabasePrivilege' => [ + 'description' => '账号权限列表。', + 'type' => 'array', + 'items' => [ + 'description' => '账号拥有的权限详情。', + 'type' => 'object', + 'properties' => [ + 'AccountPrivilege' => [ + 'description' => '账号权限，返回值：'."\n" + .'* **RoleReadOnly**：只读权限。'."\n" + .'* **RoleReadWrite**：读写权限，默认值。', + 'type' => 'string', + 'example' => 'RoleReadWrite', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查找账号信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ResetAccountPassword' => [ + 'summary' => '重置云数据库 Tair（兼容 Redis）账号的密码。', + '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' => '账号所属实例的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名，您可以调用[DescribeAccounts](~~473816~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'demoaccount', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '新密码。长度为8~32位，需包含大写字母、小写字母、特殊字符和数字中的至少三种，允许的特殊字符包括`!@#$%^&*()_+-=`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'uWonno_221****', + ], + ], + [ + 'name' => 'SourceBiz', + 'in' => 'query', + 'schema' => [ + 'description' => '本参数仅用于内部维护使用，无需传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'SDK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '重置密码', + 'description' => '> 本接口仅支持4.0或以上版本的Redis实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GrantAccountPrivilege' => [ + 'summary' => '修改云数据库 Tair（兼容 Redis）账号的权限。', + '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' => '账号所属实例的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名，您可以调用[DescribeAccounts](~~473816~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'demoaccount', + ], + ], + [ + 'name' => 'AccountPrivilege', + 'in' => 'query', + 'schema' => [ + 'description' => '账号权限，取值：'."\n" + .'* RoleReadOnly：只读权限。'."\n" + .'* RoleReadWrite：读写权限，默认值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RoleReadWrite', + ], + ], + [ + 'name' => 'SourceBiz', + 'in' => 'query', + 'schema' => [ + 'description' => '本参数仅用于内部维护使用，无需传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'SDK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改账号的权限', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateBackup' => [ + 'summary' => '为云数据库 Tair（兼容 Redis）实例创建数据备份。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '本次手动备份的过期时长，取值范围为7~730天。当您传入-1时，表示本次手动备份数据不过期（实例生命周期内）；当您不传入任何值（默认情况），表示与当前自动备份策略一致。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BackupJobID' => [ + 'description' => '备份任务ID。 '."\n" + .'针对2023-12-05前申请的集群实例，返回值是由各个子DB节点的jobId组成，例如2分片的集群实例，BackupJobID值的返回值会如 "10000,10001"。 '."\n" + .'针对2023-12-05之后申请的集群实例，一个集群下所有DB节点的job统一由一个jobId描述，用户只需关心这一个jobId即可。', + 'type' => 'string', + 'example' => '"1022,2480"', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FF6158E-3394-4A90-B634-79C49184****', + ], + ], + ], + ], + ], + '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' => '手动备份数据', + 'description' => '该API对应的控制台操作请参见[备份与恢复](~~43886~~)。', + ], + 'ModifyBackupPolicy' => [ + 'summary' => '修改云数据库 Tair（兼容 Redis）实例的自动备份策略。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => '备份时间，格式为HH:mmZ-HH:mmZ（UTC时间）。'."\n" + .'> 必须为整点，且间隔时间为1小时。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '07:00Z-08:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '备份周期，取值：'."\n" + .'* **Monday**：周一。'."\n" + .'* **Tuesday**：周二。'."\n" + .'* **Wednesday**：周三。'."\n" + .'* **Thursday**：周四。'."\n" + .'* **Friday**：周五。'."\n" + .'* **Saturday**：周六。'."\n" + .'* **Sunday**：周日。'."\n" + ."\n" + .'> 支持多选，请使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Tuesday', + ], + ], + [ + 'name' => 'EnableBackupLog', + 'in' => 'query', + 'schema' => [ + 'description' => '开启或关闭数据闪回功能，取值：'."\n" + .'* **1**：开启。同时，您还需确保已在实例的参数设置中开启AOF持久化（`appendonly`为`yes`），开启后，才能使用数据闪回功能。'."\n" + .'* **0**：关闭，默认值。'."\n" + .'> 仅Tair（企业版）内存型和持久内存型支持该参数，更多信息请参见[数据闪回](~~148479~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '数据备份保留天数。默认7天，取值范围为7~730。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '730', + 'example' => '7', + 'default' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8D0C0AFC-E9CD-47A4-8395-5C31BF9B****', + ], + ], + ], + ], + ], + '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' => '修改备份策略设置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupTasks' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的备份任务执行情况。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'BackupJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份任务ID。'."\n" + .'> 如果您调用[CreateBackup](~~473819~~)执行了手动备份，您可以将返回的备份ID传入，用以查询备份的进度。', + 'type' => 'string', + 'required' => false, + 'example' => '1162****', + 'pattern' => '^\\d+$', + ], + ], + [ + 'name' => 'JobMode', + 'in' => 'query', + 'schema' => [ + 'description' => '备份模式，取值：'."\n" + .'* **Automated**：系统自动备份，您可以调用[DescribeBackupPolicy](~~473822~~)查询自动备份策略。'."\n" + .'* **Manual**：手动备份'."\n" + ."\n" + .'> 默认返回所有备份模式的任务信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Manual', + 'enum' => [ + 'Manual', + 'Automated', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BB73740C-23E2-4392-9DA4-2660C74C****', + ], + 'BackupJobs' => [ + 'description' => '备份任务详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '备份任务开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2021-01-05T19:24:00Z', + ], + 'Process' => [ + 'description' => '备份任务进度百分比（不推荐，请查看**Progress**参数）。', + 'type' => 'string', + 'example' => '0', + ], + 'JobMode' => [ + 'description' => '备份模式，返回值：'."\n" + .'* **Automated**：系统自动备份。'."\n" + .'* **Manual**：手动备份。', + 'type' => 'string', + 'example' => 'Manual', + ], + 'BackupJobID' => [ + 'description' => '备份任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '29****10', + ], + 'BackupProgressStatus' => [ + 'description' => '备份任务状态，返回值：'."\n" + .'* **NoStart**：未开始。'."\n" + .'* **Preparing**：准备中。'."\n" + .'* **Waiting**：等待中。'."\n" + .'* **Uploading**：上传中'."\n" + .'* **Checking**：检查中。'."\n" + .'* **Finished**：已完成。', + 'type' => 'string', + 'example' => 'NoStart', + ], + 'NodeId' => [ + 'description' => '数据节点ID。', + 'type' => 'string', + 'example' => '****', + ], + 'TaskAction' => [ + 'description' => '备份任务类型，返回值：'."\n" + .'* **TempBackupTask**：临时备份任务，即手动备份。'."\n" + .'* **NormalBackupTask**：普通备份任务，即自动备份。', + 'type' => 'string', + 'example' => 'NormalBackupTask', + ], + 'Progress' => [ + 'description' => '备份的进度百分比，取值为0-100。', + 'type' => 'string', + 'example' => '27', + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '本组参数已弃用，请忽略。', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'AuthPrincipalDisplayName' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'AuthPrincipalOwnerId' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'AuthPrincipalType' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'EncodedDiagnosticMessage' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'NoPermissionType' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'PolicyType' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"InstanceId\\": \\"r-bp1zxszhcgatnx****\\",\\n \\"RequestId\\": \\"BB73740C-23E2-4392-9DA4-2660C74C****\\",\\n \\"BackupJobs\\": [\\n {\\n \\"StartTime\\": \\"2021-01-05T19:24:00Z\\",\\n \\"Process\\": \\"0\\",\\n \\"JobMode\\": \\"Manual\\",\\n \\"BackupJobID\\": 0,\\n \\"BackupProgressStatus\\": \\"NoStart\\",\\n \\"NodeId\\": \\"****\\",\\n \\"TaskAction\\": \\"NormalBackupTask\\",\\n \\"Progress\\": \\"27\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"-\\",\\n \\"AuthPrincipalDisplayName\\": \\"-\\",\\n \\"AuthPrincipalOwnerId\\": \\"-\\",\\n \\"AuthPrincipalType\\": \\"-\\",\\n \\"EncodedDiagnosticMessage\\": \\"-\\",\\n \\"NoPermissionType\\": \\"-\\",\\n \\"PolicyType\\": \\"-\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n BB73740C-23E2-4392-9DA4-2660C74C****\\r\\n r-bp1zxszhcgatnx****\\r\\n \\r\\n Automated\\r\\n NormalBackupTask\\r\\n 2021-01-05T19:24:00Z\\r\\n NoStart\\r\\n 0\\r\\n 8491111\\r\\n \\r\\n","errorExample":""}]', + 'title' => '查询备份任务执行情况', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupPolicy' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的备份策略，包括备份周期、备份时间等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BackupRetentionPeriod' => [ + 'description' => '备份保留天数。', + 'type' => 'string', + 'example' => '7', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90B82DB7-FB28-4CC2-ADBF-1F8659F3****', + ], + 'PreferredBackupPeriod' => [ + 'description' => '备份周期，返回值：'."\n" + .'* **Monday**：周一。'."\n" + .'* **Tuesday**：周二。'."\n" + .'* **Wednesday**：周三。'."\n" + .'* **Thursday**：周四。'."\n" + .'* **Friday**：周五。'."\n" + .'* **Saturday**：周六。'."\n" + .'* **Sunday**：周日。 ', + 'type' => 'string', + 'example' => 'Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday', + ], + 'PreferredNextBackupTime' => [ + 'description' => '下次备份时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '2019-03-14T05:28Z', + ], + 'PreferredBackupTime' => [ + 'description' => '备份时间，格式为HH:mmZ-HH:mmZ（UTC时间）。', + 'type' => 'string', + 'example' => '05:00Z-06:00Z', + ], + 'EnableBackupLog' => [ + 'description' => '是否开启了增量备份，返回值：'."\n" + .'* **1**：已开启。'."\n" + .'* **0**：未开启。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AccessDeniedDetail' => [ + 'description' => '本组参数已弃用，请忽略。', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + 'AuthPrincipalDisplayName' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'AuthPrincipalOwnerId' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'AuthPrincipalType' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'EncodedDiagnosticMessage' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'NoPermissionType' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'PolicyType' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + ], + 'required' => false, + ], + 'DbsInstance' => [ + 'description' => '实例是否启用备份服务化，取值：'."\n" + .'* **1**：开启'."\n" + .'* **0**：未开启', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + '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' => '查询自动备份策略', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackups' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的备份文件信息。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11611111', + ], + ], + [ + 'name' => 'BackupJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份任务ID，由CreateBackup返回，CreateBackup若返回多个BackupJobId，则需要使用本接口分别对其查询。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页最大记录数，取值：30、50、100、200或300。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + '200', + '300', + '1000', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值大于**0**且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-03-11T10:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-03-14T18:00Z', + ], + ], + [ + 'name' => 'NeedAof', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启AoF落盘，取值：'."\n" + .'* **0**：关闭。'."\n" + .'* **1**：开启。'."\n" + ."\n" + .'> 默认值：**0**。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '963C20F0-7CE1-4591-AAF3-6F3CD1CE****', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页最大记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '备份总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'FullStorageSize' => [ + 'description' => '当前实例全量备份文件的大小，单位是字节。全量备份来源于每天定时备份、手动备份、缓存分析时生成的备份等。'."\n" + .'> 该值和当前请求所响应的备份集数量以及大小无关，而是该实例当前所有有效全量备份的大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'LogStorageSize' => [ + 'description' => '当前实例日志备份文件的大小，单位是字节，当且仅当开启闪回时才有效。'."\n" + .'> 该值和当前请求所响应的备份集数量以及大小无关，而是该实例当前所有有效日志备份的大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + 'FreeSize' => [ + 'description' => '该实例的免费备份额度，单位是字节，免费额度为实例规格默认内存量，更多信息请参见[备份商业化通知](~~2664017~~)。'."\n" + .'全量备份和日志备份共享该免费额度。当变配实例规格时，实例的免费额度会产生变化。'."\n" + .'该参数未生效，请忽略该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'Backups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Backup' => [ + 'description' => '备份集详情。', + 'type' => 'array', + 'items' => [ + 'description' => '备份集详情。', + 'type' => 'object', + 'properties' => [ + 'BackupStatus' => [ + 'description' => '备份状态，返回值：'."\n" + .'* **Success**：成功。'."\n" + .'* **Failed**：失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'BackupStartTime' => [ + 'description' => '备份开始时间。', + 'type' => 'string', + 'example' => '2019-03-14T05:28:50Z', + ], + 'BackupType' => [ + 'description' => '备份类型，返回值：'."\n" + .'* **FullBackup**：全量备份。'."\n" + .'* **IncrementalBackup**：增量备份。', + 'type' => 'string', + 'example' => 'FullBackup', + ], + 'BackupDownloadURL' => [ + 'description' => '备份文件的外网下载地址。', + 'type' => 'string', + 'example' => 'https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********', + ], + 'NodeInstanceId' => [ + 'description' => '节点ID。'."\n" + .'> 当实例的架构为标准版时，本参数返回的是实例ID。', + 'type' => 'string', + 'example' => 'r-bp10noxlhcoim2****-db-1', + ], + 'BackupEndTime' => [ + 'description' => '备份结束时间。', + 'type' => 'string', + 'example' => '2019-03-14T05:31:13Z', + ], + 'BackupId' => [ + 'description' => '备份文件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '165*****50', + ], + 'BackupDBNames' => [ + 'description' => '备份的数据库，默认为**all**，即备份所有数据库。', + 'type' => 'string', + 'example' => 'all', + ], + 'EngineVersion' => [ + 'description' => '引擎版本，即实例兼容Redis的版本。', + 'type' => 'string', + 'example' => '4.0', + ], + 'BackupIntranetDownloadURL' => [ + 'description' => '备份文件的内网下载地址。'."\n" + ."\n" + .'> 您可以在与该实例连通的ECS（二者需属于同一VPC内）上使用该地址下载目标备份文件。', + 'type' => 'string', + 'example' => 'https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********', + ], + 'BackupSize' => [ + 'description' => '备份文件大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'BackupMode' => [ + 'description' => '备份模式，返回值：'."\n" + .'* **Automated**：自动备份。'."\n" + .'* **Manual**：手动备份。'."\n" + .' ', + 'type' => 'string', + 'example' => 'Automated', + ], + 'BackupMethod' => [ + 'description' => '备份方法，返回值：'."\n" + .'* **Logical**：逻辑备份。'."\n" + .'* **Physical**：物理备份。 '."\n" + .' ', + 'type' => 'string', + 'example' => 'Physical', + ], + 'BackupJobID' => [ + 'description' => '备份任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24340', + ], + 'RecoverConfigMode' => [ + 'description' => '备份集中是否包含了账号（account）、内核参数（whitelist）、白名单（config）信息。'."\n" + .'> 本参数仅适用于云原生版实例。若您修改实例的上述信息（例如新建了一个账号或添加了一个白名单），在后续的备份集中会自动备份上述信息。', + 'type' => 'string', + 'example' => '{"whitelist":true,"config":true,"account":true}', + ], + 'ExpectExpireTime' => [ + 'description' => '备份集过期时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。', + 'type' => 'string', + 'example' => '2025-06-01T21:51:22Z', + ], + ], + ], + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '本组参数已弃用，请忽略。', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'AuthPrincipalDisplayName' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'AuthPrincipalOwnerId' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'AuthPrincipalType' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'EncodedDiagnosticMessage' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'NoPermissionType' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + 'PolicyType' => [ + 'description' => '说明如上。', + 'type' => 'string', + 'example' => '-', + ], + ], + ], + ], + ], + ], + ], + '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' => '查看备份集列表', + 'description' => '本接口不适用云原生版集群架构实例，如有需要请使用[DescribeClusterBackupList](~~2679168~~)接口。', + ], + 'RestoreInstance' => [ + 'summary' => '恢复指定备份文件中的数据到云数据库 Tair（兼容 Redis）实例中。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的备份文件ID。您可以调用[DescribeBackups](~~473823~~)查询。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '78241****', + 'default' => '0', + ], + ], + [ + 'name' => 'RestoreType', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复类型，取值：'."\n" + .'* **0**（默认）：参数已失效。'."\n" + .'* **1**：恢复至指定的时间点，仅当实例开启了[数据闪回](~~148479~~)功能时，您才可以传入该值。传入为该值时，您还需要传入**RestoreTime**参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'pattern' => '^\\d+$', + 'default' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'RestoreTime', + 'in' => 'query', + 'schema' => [ + 'description' => '要恢复的时间点，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'> 该时间点不能早于开启数据闪回功能的时间点。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-07-06T07:25:57Z', + ], + ], + [ + 'name' => 'FilterKey', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要恢复的Key，支持正则表达式，多个值使用英文逗号（,）分隔。'."\n" + .'- 当不传入该参数时，表示恢复整个实例。'."\n" + .'- 当传入该参数时，表示仅恢复相关Key。且仅经典版实例支持该功能。'."\n" + .'> 例如正则表达式中，星号（`*`）表示匹配前面子表达式任意次，本参数传入`h.*llo`，系统将匹配`hllo`或`heeeello`等字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'key:00000007198*', + ], + ], + [ + 'name' => 'TimeShift', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '当恢复经典版实例时，不论您选择恢复全量数据或指定Key，您都可以对Key的过期时间进行偏移处理。格式为yyyy-MM-ddTHH:mmZ（UTC时间）。实例会将Key在指定闪回时间点所剩余的过期时长，偏移至设置的过期偏移时间点开始计算。'."\n" + .'> * 该功能仅支持偏移Key级别的过期时间，不支持偏移Tair自研数据结构中Key内部的过期时间，例如exHash的Field、TS的Skey等。'."\n" + .'> * 该时间点不能早于指定的闪回时间点，也不能晚于提交恢复任务的时间点。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-07-06T08:25:57Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '恢复数据', + 'description' => '* 当您的实例为[内存型](~~126164~~)或[持久内存型](~~183956~~)，且已开启了[数据闪回](~~148479~~)，您可以调用本接口将实例整体或指定Key恢复至某个秒级时间点，可实现更精细化的数据恢复。'."\n" + .'* 除上述以外的实例，推荐调用[CreateInstance](~~473757~~)或[CreateTairInstance](~~473770~~)接口，将备份数据恢复至新实例中。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeClusterBackupList' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）集群实例的备份列表。', + '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' => '实例所属的地域ID，可调用[DescribeRegions](~~473763~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-zhangjiakou', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-t4nj72oug5r5646qog', + ], + ], + [ + 'name' => 'ClusterBackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群备份集ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cb-hyxdof5x9kqbtust'."\n", + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页可展示的记录数。', + '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' => '当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2024-06-28T08:26Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2024-07-01T09:26Z', + ], + ], + [ + 'name' => 'NoShardBackup', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '是否展示集群节点的备份集详情：'."\n" + .'* **false**（默认）：展示集群节点的备份集信息。'."\n" + .'* **true**：不展示集群节点的备份集信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'True', + 'enum' => [ + 'True', + 'False', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'C009DA42-3B19-5B81-963D-1509DE2408DD', + ], + 'MaxResults' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => 'MaxResults本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'PageNumber' => [ + 'title' => '第几页，同请求参数', + 'description' => '第几页，同请求参数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '一页最大多少条记录，同请求参数', + 'description' => '一页最大多少条记录，同请求参数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'FullStorageSize' => [ + 'title' => '当前实例全量备份大小', + 'description' => '当前实例全量备份文件的大小，单位是字节。全量备份来源于每天定时备份、手动备份、缓存分析时生成的备份等。'."\n" + .'>该值和当前请求所响应的备份集数量以及大小无关，而是该实例当前所有有效全量备份的大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'LogStorageSize' => [ + 'title' => '当前实例日志备份大小', + 'description' => '当前实例日志备份文件的大小，单位是字节，当且仅当开启闪回时才有效。'."\n" + .'>该值和当前请求所响应的备份集数量以及大小无关，而是该实例当前所有有效日志备份的大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + 'FreeSize' => [ + 'title' => '当前实例备份免费量', + 'description' => '该实例的免费备份额度，单位是字节，免费额度为实例规格默认内存量，更多信息请参见备份商业化通知。 全量备份和日志备份共享该免费额度。当变配实例规格时，实例的免费额度会产生变化。'."\n" + .'该参数未生效，请忽略该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'ClusterBackups' => [ + 'title' => '集群备份集列表，一个集群备份里面包含各个节点的备份集', + 'description' => '集群备份集列表，一个集群备份里面包含各个节点的备份集', + 'type' => 'array', + 'items' => [ + 'description' => '集群备份集列表，一个集群备份里面包含各个节点的备份集。', + 'type' => 'object', + 'properties' => [ + 'IsAvail' => [ + 'title' => '集群备份集是否有效，子节点的备份集未完成或者失败时，为0', + 'description' => '集群备份集是否有效，子节点的备份集未完成或者失败时，为0', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterBackupId' => [ + 'title' => '集群备份集ID', + 'description' => '集群备份集ID', + 'type' => 'string', + 'example' => 'cb-zmdqj2m3xyxjtdt0', + ], + 'ClusterBackupStatus' => [ + 'title' => '集群备份集状态', + 'description' => '集群备份集状态。'."\n" + ."\n" + .'- 成功：OK'."\n" + .'- 运行中：RUNNING'."\n" + .'- 失败：其他字段', + 'type' => 'string', + 'example' => 'OK', + ], + 'ClusterBackupSize' => [ + 'title' => '集群备份集大小', + 'description' => '集群备份集大小', + 'type' => 'string', + 'example' => '2048', + ], + 'ClusterBackupStartTime' => [ + 'description' => '集群备份开始时间。', + 'type' => 'string', + 'example' => '2024-01-10T17:21:25Z', + ], + 'ClusterBackupEndTime' => [ + 'description' => '集群备份结束时间。', + 'type' => 'string', + 'example' => '2024-01-10T17:21:55Z', + ], + 'ClusterBackupMode' => [ + 'description' => '集群备份模式。', + 'type' => 'string', + 'example' => 'Automated', + ], + 'ShardClassMemory' => [ + 'title' => '做全量备份时，当时单个DB节点的内存规格大小，单位为MB', + 'description' => '做全量备份时，当时单个DB节点的内存规格大小，单位为MB', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'Backups' => [ + 'title' => '单个集群备份集下，各个子节点的备份集集合', + 'description' => '单个集群备份集下，各个子节点的备份集集合', + 'type' => 'array', + 'items' => [ + 'description' => '备份集详情。', + 'type' => 'object', + 'properties' => [ + 'BackupId' => [ + 'description' => '备份文件的ID。', + 'type' => 'string', + 'example' => '514645788', + ], + 'InstanceName' => [ + 'description' => '实例的名称。', + 'type' => 'string', + 'example' => 'r-bp1y4is8svonly****-db-0', + ], + 'BackupDownloadURL' => [ + 'description' => '备份文件的外网下载地址。', + 'type' => 'string', + 'example' => 'http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb', + ], + 'BackupIntranetDownloadURL' => [ + 'description' => '备份文件的内网下载地址。'."\n" + ."\n" + .'> 您可以在与该实例连通的ECS（二者需属于同一VPC内）上使用该地址下载目标备份文件。', + 'type' => 'string', + 'example' => 'http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb', + ], + 'RecoverConfigMode' => [ + 'description' => '该参数暂未生效，请忽略该参数。', + 'type' => 'string', + 'example' => 'null', + ], + 'BackupStartTime' => [ + 'description' => '本次备份开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2024-01-09T17:21:30Z', + ], + 'BackupEndTime' => [ + 'description' => '本次备份结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2024-01-09T17:21:57', + ], + 'BackupSize' => [ + 'description' => '备份文件大小，单位为Byte。', + 'type' => 'string', + 'example' => '1024', + ], + 'IsAvail' => [ + 'description' => '备份集是否可用，取值说明：'."\n" + .'* **0**：不可用。'."\n" + .'* **1**：可用。', + 'type' => 'string', + 'example' => '1', + ], + 'BackupStatus' => [ + 'description' => '备份状态，返回值：'."\n" + .'* **OK**：成功。'."\n" + .'* **ERROR**：失败。', + 'type' => 'string', + 'example' => 'OK', + ], + 'BackupName' => [ + 'description' => '备份名称。', + 'type' => 'string', + 'example' => 'hins100322105_data_20240110012135.rdb', + ], + 'Engine' => [ + 'description' => '数据库类型，返回值固定为**redis**。', + 'type' => 'string', + 'example' => 'redis', + ], + 'ExtraInfo' => [ + 'description' => '附加信息', + 'type' => 'object', + 'properties' => [ + 'CustinsDbVersion' => [ + 'description' => 'DB 的版本', + 'type' => 'string', + 'example' => '5.0', + ], + ], + ], + ], + ], + ], + 'Progress' => [ + 'title' => '备份进度，仅正在运行的备份才会显示进度', + 'description' => '备份进度，仅正在运行的备份才会显示进度', + 'type' => 'string', + 'example' => '100%', + ], + 'ExpectExpireTime' => [ + 'description' => '备份集过期时间，格式为yyyy-MM-ddTHH:mmZ（UTC 时间）。', + 'type' => 'string', + 'example' => '2025-06-01T21:51:22Z', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询集群实例的备份列表', + 'description' => '本接口仅适用于云原生版实例。', + ], + 'DescribeDBInstanceMonitor' => [ + 'summary' => '查询Tair实例的监控采集粒度', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '56393', + 'abilityTreeNodes' => [ + 'FEATUREkvstoreW1V0SW', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1xp9esa45nll****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Interval' => [ + 'description' => '监控数据的采集粒度，单位为秒。', + 'type' => 'string', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '276F582D-C6B2-519C-A5ED-2A92BB15EC07', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Interval\\": \\"5\\",\\n \\"RequestId\\": \\"276F582D-C6B2-519C-A5ED-2A92BB15EC07\\"\\n}","type":"json"}]', + 'title' => '查询Tair实例的监控采集粒度', + ], + 'DescribeMonitorItems' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例支持的监控项列表。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '8BEB2618-9517-43F3-A233-E0B34512****', + ], + 'MonitorItems' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'KVStoreMonitorItem' => [ + 'description' => '监控参数列表。'."\n" + ."\n" + .'> * **memoryUsage**、**GetQps**和**PutQps**监控指标仅在4.0及以上版本的实例中支持。其中，**GetQps**和**PutQps**监控指标需要实例为最新的小版本。升级方法请参见[升级大版本](~~101764~~)和[升级小版本](~~56450~~)。'."\n" + .'> * 实例版本为兼容Redis 2.8版本时，如果没有展示**hit_rate**监控指标，您需要升级小版本，详情请参见[升级小版本](~~56450~~)。', + 'type' => 'array', + 'items' => [ + 'description' => '监控项对象。', + 'type' => 'object', + 'properties' => [ + 'Unit' => [ + 'description' => '监控项使用的单位。', + 'type' => 'string', + 'example' => 'Counts/s', + ], + 'MonitorKey' => [ + 'description' => '监控项。', + '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' => '查询监控项列表', + 'description' => '> 为提升用户体验，云数据库 Tair（兼容 Redis）对性能监控进行了升级，本接口将下线。更多信息，请参见[【通知】云数据库 Tair（兼容 Redis）DescribeMonitorItems接口下线](~~189893~~)。'."\n" + ."\n" + .'调用本接口获取到监控项列表后，您可以调用[DescribeHistoryMonitorValues](~~473827~~)接口查询实例的历史监控信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeHistoryMonitorValues' => [ + 'summary' => '查看云数据库 Tair（兼容 Redis）实例的性能监控信息。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询历史监控开始时间点，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-11-06T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询历史监控结束时间点，须晚于历史监控开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + ."\n" + .'> 支持查询最近1个月的监控数据，且最大查询范围不能超过7天。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-11-06T00:30:00Z', + ], + ], + [ + 'name' => 'IntervalForHistory', + 'in' => 'query', + 'schema' => [ + 'description' => '本参数已废弃，固定取值为`01m`。'."\n" + ."\n" + .'实际会根据查询的开始时间和结束时间自动决定**查询的时间间隔**。以查询时间范围小于等于10分钟为例，数据聚合频率为5s/次，查询结果会按照5s/次的频率返回。'."\n" + .'> * 查询结果会与实例的数据聚合频率对齐。若您传入的 StartTime 不在数据聚合时间点上，系统返回的首个时间点为最近的数据聚合时间点。例如您传入的 StartTime 为 2022-01-20T12:01:48Z，系统返回的首个时间点为 2022-01-20T12:01:45Z。'."\n" + .'> * 如果实例的数据分片数大于等于32，最小的数据聚合频率为1分钟/次。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '01m', + 'enum' => [ + '01m', + '05m', + '15m', + '60m', + ], + ], + ], + [ + 'name' => 'MonitorKeys', + 'in' => 'query', + 'schema' => [ + 'description' => '监控指标，如需传入多个监控指标，需使用英文逗号（,）分隔。以CpuUsage为例：'."\n" + .'* 集群节点或读写分离架构：'."\n" + .' - 若您希望查询所有数据节点（DB）整体的CPU使用率，请传入**CpuUsage$db**。'."\n" + .' - 若您希望查询单个数据节点的CPU使用率，请传入**CpuUsage**，同时在NodeId参数指定DB 节点。'."\n" + ."\n" + .'* 标准架构（主备）：传入**CpuUsage**即可。'."\n" + ."\n" + .'更多信息监控指标与详细说明，请参见下方的[MonitorKeys参数补充说明](https://help.aliyun.com/zh/redis/developer-reference/api-r-kvstore-2015-01-01-describehistorymonitorvalues-redis#monitorKeys-note)[MonitorKeys参数补充说明](https://www.alibabacloud.com/help/zh/redis/developer-reference/api-r-kvstore-2015-01-01-describehistorymonitorvalues-redis#monitorKeys-note)。'."\n" + .'> * 默认为空，将返回UsedMemory与quotaMemory指标。'."\n" + .'> * 为保障查询效率，查询单个节点的监控指标时，建议单次传入不超过5个监控指标；查询聚合监控指标时，建议单次不超过传入1个监控指标。', + 'type' => 'string', + 'required' => false, + 'example' => 'CpuUsage', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的中的节点ID。传入本参数可查询指定节点的监控信息。'."\n" + ."\n" + .'> * 当实例的架构为读写分离或集群架构时，本参数才可用。'."\n" + .'> * 您可以调用[DescribeLogicInstanceTopology](~~473786~~)接口查询节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****-db-0#1679****', + ], + ], + [ + 'name' => 'NodeRole', + 'in' => 'query', + 'schema' => [ + 'description' => '若希望查询云原生版读写分离架构实例中只读节点的指标，您在传入具体**NodeId**的同时，还需要在本参数传入**READONLY**。'."\n" + .'> 其余情况请无需传入（或传入**MASTER**）。', + 'type' => 'string', + 'required' => false, + 'example' => 'READONLY', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MonitorHistory' => [ + 'description' => '以JSON格式返回的监控信息，更多信息，请参见[监控参数说明](~~122091~~)。'."\n" + ."\n" + .'> 为提高数据传输效率，只有非0的监控数据才会返回，其余未显示的监控数据均为默认值**0**。', + 'type' => 'string', + 'example' => '"{\\"2022-11-06T00:00:00Z\\":{\\"memoryUsage\\":\\"6.67\\"},\\"2022-11-06T00:00:05Z\\":{\\"memoryUsage\\":\\"6.67\\"},\\"2022-11-06T00:00:10Z\\":{\\"memoryUsage\\":\\"6.67\\"},\\"2022-11-06T00:00:15Z\\":{\\"memoryUsage\\":\\"6.67\\"},\\"2022-11-06T00:00:20Z\\":{\\"memoryUsage\\":\\"6.67\\"},\\"2022-11-06T00:00:25Z\\":{\\"memoryUsage\\":\\"6.67\\"}}"', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F0997EE8-F4C2-4503-9168-85177ED7****', + ], + ], + ], + ], + ], + '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' => '查看实例的性能监控信息', + 'description' => '该API对应的控制台操作请参见[性能监控](~~43887~~)。', + 'requestParamsDescription' => '

MonitorKeys参数补充说明

'."\n" + ."\n" + .'调用OpenAPI时，请传入下表MonitorKeys列参数，系统将返回子监控项。实例支持通用类监控项和命令统计类监控项。'."\n" + .'#### 通用类监控项'."\n" + .'通用类监控项的使用说明如下，以CpuUsage为例。'."\n" + .'* 集群节点或读写分离架构：'."\n" + .'
  • 查询所有数据节点（DB）整体的CPU使用率：您需要传入CpuUsage$db。
  • 查询所有Proxy节点整体的CPU使用率：您需要传入CpuUsage$proxy。
  • 查询单个数据节点或Proxy节点的CPU使用率：您需要传入CpuUsage，同时在NodeId参数指定DB节点或Proxy节点。
'."\n" + ."\n" + .'* 标准架构（主备）：传入**CpuUsage**即可。'."\n" + ."\n" + .'

MonitorKeys

子监控项

单位

说明

支持范围

CpuUsage

CpuUsage

%

CPU使用率，范围为0~100。

若您的实例原先传入或返回RedisCpuUsage参数，您仍可以使用原参数。

  • DB

  • DB聚合

  • Proxy

  • Proxy聚合

MemoryUsage

memoryUsage

%

内存使用率。

  • DB

  • DB聚合

quotaMemory

quotaMemory

Bytes

当前分片的内存总量。

  • DB

  • DB聚合

UsedMemory

UsedMemory

Bytes

已使用内存量，包含数据和缓存部分。

  • DB

  • DB聚合

Tair_PmemUsage

PmemUsage

%

分别为持久内存使用率、持久内存已使用量和持久内存的内存总量。

仅持久内存型实例支持。

  • DB

  • DB聚合

Tair_Pmem

PmemUsed

Bytes

PmemQuota

Bytes

Redis_DetailedSpaceUsage

ins_size

MB

分别为实例占用总磁盘空间、数据文件占用的磁盘空间（包括AOF、RDB文件）和日志文件占用的磁盘空间（包含运行日志）。

仅经典部署模式（原本地盘）的内存型实例支持。

  • DB

  • DB聚合

data_size

MB

log_size

MB

Redis_Memory_Monitor

used_memory_rss

Bytes

该进程所占的物理内存，即操作系统分配给Tair服务的内存。

  • DB

used_memory_lua

Bytes

Lua脚本使用内存量。

used_memory_startup

Bytes

Tair启动时消耗的内存。

lazyfree_pending_objects

Counts

Tair执行lazy free操作，在等待被实际回收内容的键个数。

used_memory_overhead

Bytes

Tair为维护数据集的内部机制所需的内存开销，包括所有客户端的输出缓冲区、查询缓冲区和AOF。

used_memory_dataset

Bytes

数据占用的内存空间。

UsedQPS

TotalQps

Counts/s

每秒总请求数，包含读和写命令。

  • DB

  • DB聚合

  • Proxy

  • Proxy聚合

GetQps

Counts/s

分别代表每秒读、写命令的请求数。实例的兼容版本需为Redis 4.0及以上。

PutQps

Counts/s

OtherOps

Counts/s

指PING、INFO、SELECT与AUTH等无读写属性的请求。由于Proxy对请求存在特殊处理，若实例带有Proxy节点，则OtherOps仅包含部分INFO请求。

ConnectionUsage

connectionUsage

%

连接数使用率，计算方法：已连接数÷实例支持的总连接数。客户端通过直连地址连接至实例（集群架构）时，此指标具备参考价值。

  • DB

  • DB聚合

UsedConnection

ConnCount

Counts

已使用连接数。

IntranetIn

InFlow

KB/s

入、出流量速率。

  • DB

  • DB聚合

  • Proxy

  • Proxy聚合

IntranetOut

OutFlow

KB/s

IntranetInRatio

intranetInRatio

%

入、出流量使用率。

  • DB

  • DB聚合

IntranetOutRatio

intranetOutRatio

%

Redis_Avg_Rt_Monitor

AvgRt

us

平均时延，表示后端节点从接收命令到发出响应的时延平均值。

  • DB节点的该指标不包含Proxy与负载均衡的耗时。
  • Proxy节点的该指标包含DB与Proxy的耗时，但不包含负载均衡的耗时。

  • DB

  • DB聚合

  • Proxy

  • Proxy聚合

Redis_Max_Rt_Monitor

MaxRt

us

最大时延，表示节点从接收命令到发出响应的时延最大值。

  • DB节点的该指标不包含Proxy与负载均衡的耗时。
  • Proxy节点的该指标包含DB与Proxy的耗时，但不包含负载均衡的耗时。

Redis_Basic_Monitor

Keys

Counts

Key总数量，即实例存储的一级Key总数。

  • DB

  • DB聚合

Expires

Counts

实例中设置过期时间的Key数量，该指标展示的是采集数据时的瞬时值。

ExpiredKeys

Counts

历史累计淘汰的Key总数。

EvictedKeys

Counts

历史累计逐出的Key总数。

ExpiredKeysPerSecond

Counts/s

每秒淘汰的Key数量。

EvictedKeysPerSecond

Counts/s

每秒逐出的Key数量。

inmem_keys

Counts

该参数仅混合存储型实例（已停售）支持，可忽略。

swapped_keys

Counts

Hit_Rate_Monitor

hit_rate

%

命中率计算方法：Key命中数÷（Key命中数+Key未命中数）。

  • DB

  • DB聚合

hit

Counts

每秒命中的Key数量。

miss

Counts

每秒未命中的key数量。

evicted_keys_per_sec

Counts

每秒被驱逐的Key数量。

DiskUsage

disk_usage

%

分别为磁盘使用率、输入缓冲区占用大小、输出缓冲区占用大小和磁盘性能监控项，仅磁盘型实例支持。

  • DB

RocksDBConn

Tair_Connection_Monitor

Bytes

Tair_Connection_Monitor

Bytes

Tair_Disk_Monitor

io_bandwidth_kbps、iops、iops_usage等。

%、ms、Counts等。

UsedConnection

ConnectionUsage

%

连接数使用率，计算方法：已使用连接数÷节点支持的最大连接数。客户端通过Proxy节点连接至实例（集群或读写分离架构）时，此指标具备参考价值。

  • Proxy

  • Proxy聚合

UsedConnection

Counts

已使用连接数。

NewUserConnQps

Counts/s

客户端到Proxy节点每秒建立的连接数。

Redis_Package_Monitor

request

Byte

单个请求的平均字节数。

  • Proxy

response

Byte

单个响应的平均字节数。

request_max

Byte

单个请求的最大字节数。

response_max

Byte

单个响应的最大字节数。

RedisProxyConn

RedisUsedConnection

Counts

Proxy节点到数据节点的连接数。

NewDBConnQps

Counts/s

Proxy节点到数据节点每秒建立的连接数。

DisconnectDBConn

Counts

Proxy节点到数据节点累计断连次数。

DisconnectUserConn

Counts

客户端到Proxy节点的累计断连次数。

TotalCalls

TotalRefusedCommands

Counts

累计拒绝命令数。

TotalCallsPerSecCalls

Counts/s

每秒请求数。

TotalCallsPerSecRetryCalls

Counts/s

每秒请求重试数。

TotalCallsPerSecRetryFailed

Counts/s

每秒失败请求数。

'."\n" + ."\n" + .'
'."\n" + .'命令统计类监控项（如需查看请展开）'."\n" + .'命令统计类监控项仅支持查询指定DB。在查询时，您需要传入对应的MonitorKeys参数，同时还需要在NodeId参数指定DB节点。'."\n" + ."\n" + .'> Tair扩展命令监控组仅经典部署模式（原本地盘）的内存型实例支持。'."\n" + .'

MonitorKeys

子监控项

单位

说明

Redis_Keys_Monitor

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

Counts/s

使用键值相关命令的监控信息，例如DEL、EXISTS等命令的调用次数。

Redis_String_Monitor

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

Counts/s

使用String数据类型相关命令的监控信息，例如APPEND、MGET等命令的调用次数。

Redis_Hashes_Monitor

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

Counts/s

使用Hash数据类型相关命令的监控信息，例如HGET、HDEL等命令的调用次数。

Redis_Lists_Monitor

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

Counts/s

使用Lists数据类型相关命令的监控信息，例如BLPOP、BRPOP等命令的调用次数。

Redis_Sets_Monitor

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

Counts/s

使用Sets数据类型相关命令的监控信息，例如SADD、SCARD等命令的调用次数。

Redis_Zset_Monitor

zadd、zcard、zcount、zincrby、zrange、zrangebyscore、zrank、zrem、zremrangebyrank、zremrangebyscore、zrevrange、zrevrangebyscore、zrevrank、zscore、zunionstore、zinterstore、zscan、zrangebylex、zlexcount、zremrangebylex、zpopmin、zpopmax、bzpopmin、bzpopmax

Counts/s

使用Zset数据类型相关命令的监控信息，例如ZADD、ZCARD等命令的调用次数。

Redis_Hyperlog_Monitor

pfadd、pfcount、pfmerge

Counts/s

使用HyperLogLog数据类型相关命令的监控信息，例如PFADD、PFCOUNT等命令的调用次数。

Redis_Pub_Sub_Monitor

psubscribe、publish、pubsub、punsubscribe、subscribe、unsubscribe

Counts/s

使用发布与订阅（Pub/Sub）功能相关命令的监控信息，例如PUBLISH、SUBSCRIBE等命令的调用次数。

Redis_Transaction_Monitor

discard、exec、multi、unwatch、watch

Counts/s

使用事务（Transaction）相关命令的监控信息，例如WATCH、MULTI等命令的调用次数。

Redis_Scripting_Monitor

eval、evalsha、script

Counts/s

使用Scripting相关命令的监控信息，例如EVAL、EVALSHA等命令的每秒调用次数。

Calls_Monitor

flushall_calls、flushdb_calls、keys_calls

Counts

FLUSHALL、FLUSHDB、KEYS命令累计调用次数。

Redis_Connection_Monitor

auth、echo、ping、quit、select

Counts/s

使用Connection相关命令的监控信息，例如AUTH、ECHO等命令的每秒调用次数。

Redis_Server_Monitor

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

Counts/s

使用Server相关命令的监控信息，例如BGSAVE、CONFIG等命令的每秒调用次数。

Redis_Geo_Monitor

geoadd、geohash、geopos、geodist、georadius、georadiusbymember

Counts/s

使用Geo相关命令的监控信息，例如GEOADD、GEOHASH等命令的每秒调用次数。

Redis_Streams_Monitor

xinfo、xadd、xtrim、xdel、xrange、xrevrange、xlen、xread、xgroup、xreadgroup、xack、xclaim、xpending

Counts/s

使用Streams相关命令的监控信息，例如XINFO、XADD等命令的每秒调用次数。

当前这三行跑不通，先注释掉。

Counts/s

使用Lua脚本相关命令的监控信息，例如EVAL、SCRIPT等命令的调用次数。

Redis_TairDoc_Monitor

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

Counts/s

Doc监控组，使用Doc相关命令的监控信息，例如JSON.SET、JSON.GET等命令的调用次数。

Redis_TairHash_Monitor

exhset、exhsetnx、exhmset、exhexpireat、exhexpire、exhmsetwithopts、exhpexpireat、exhpexpire、exhpttl、exhttl、exhver、exhsetver、exhincrby、exhincrbyfloat、exhget、exhgetwithver、exhmget、exhdel、exhlen、exhexists、exhkeys、exhvals、exhgetall、exhmgetwithver、exhsterlen、exhscan

Counts/s

exHash监控组，使用exHash相关命令的监控信息，例如EXHSET、EXHMSET等命令的调用次数。

Redis_TairString_Monitor

cas、cad、exset、exget、exsetver、exincrby、exincrbyfloat、excas、excad

Counts/s

exString监控组，使用exString相关命令的监控信息，例如EXSET、EXGET等命令的调用次数。

Redis_TairGis_Monitor

gisadd、gisget、gisdel、gissearch、giscontains、gisintersects、gisgetall

Counts/s

GIS监控组，使用GIS相关命令的监控信息，例如GIS.ADD、GIS.GET、GIS.DEL等命令的调用次数。

Redis_TairBloom_Monitor

bfadd、bfmadd、bfexists、bfmexists、bfinsert、bfreserve、bfdebug

Counts/s

Bloom监控组，使用Bloom相关命令的监控信息，例如BF.RESERVE、BF.ADD等命令的调用次数。

'."\n" + .'
', + ], + 'ModifyAuditLogConfig' => [ + 'summary' => '开启或修改云数据库 Tair（兼容 Redis）实例的审计日志设置。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Retention', + 'in' => 'query', + 'schema' => [ + 'description' => '审计日志保留天数，取值：**1**~**365**。'."\n" + .'> * 当**DbAudit**取值为**true**时，本参数必须传入。'."\n" + .'> * 本参数的设置对当前地域下的所有实例生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '365', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'DbAudit', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启审计日志，取值：'."\n" + .'* **true**：默认值，开启。'."\n" + .'* **false**：关闭。'."\n" + ."\n" + .'> 当实例为[集群架构](~~52228~~)或[读写分离架构](~~62870~~)时，会同时开启或关闭数据节点和代理节点的审计日志，不支持单独开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改审计日志设置', + 'description' => '请确保在使用该接口前，已充分了解审计日志的收费方式和[价格](~~54532~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAuditLogConfig' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例审计日志是否开启、日志保存时间等配置信息。', + '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' => '实例所属地域的ID，您可以调用[DescribeInstanceAttribute](~~473779~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hanghzou', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Retention' => [ + 'description' => '审计日志的保留时长，单位为天。', + 'type' => 'string', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', + ], + 'DbAudit' => [ + 'description' => '是否开启审计日志，返回值：'."\n" + .'* **true**：开启。'."\n" + .'* **false**：关闭。'."\n" + ."\n" + .'> 您可以调用[ModifyAuditLogConfig](~~473829~~)接口为实例开启或关闭审计日志。', + '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' => '查询审计日志配置', + 'description' => '调用本接口时，实例必须已开启审计日志开关，详情请参见[ModifyAuditLogConfig](~~473829~~)或[审计日志](~~102015~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAuditRecords' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的审计日志。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '56381', + 'abilityTreeNodes' => [ + 'FEATUREkvstoreE2TR4H', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的实例的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例中的节点ID。传入本参数可查询指定节点的监控信息。'."\n" + ."\n" + .'> * 当实例的架构为读写分离或集群架构时，本参数才可用。'."\n" + .'> * 您可以调用[DescribeLogicInstanceTopology](~~473786~~)接口查询节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****-db-0', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '账号名称，默认（不填任何值）表示查询所有账号。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例中的Database，默认（不填任何值）表示查询所有DB，取值为0 ~ 255，示例0表示DB 0。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'QueryKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => '根据指定的命令查询审计日志，默认查询所有执行过的命令。'."\n" + ."\n" + .'> 只能传入单个关键词。', + 'type' => 'string', + 'required' => false, + 'example' => 'maxclients', + ], + ], + [ + 'name' => 'HostAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端IP，默认（不填任何值）为查询所有地址。', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的最大记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前显示的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-03-24T12:10:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'> 由于审计日志的条目数较多，一般查询的时间范围建议在10分钟以内，最长不超过1天。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-03-25T12:10:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '查询结束时间。', + 'type' => 'string', + 'example' => '2019-03-25T12:10:00Z', + ], + 'StartTime' => [ + 'description' => '查询开始时间。', + 'type' => 'string', + 'example' => '2019-03-24T12:10:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9F5EB478-824E-4AC4-8D2B-58F31A02****', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22222', + ], + 'PageNumber' => [ + 'description' => '当前显示的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的最大记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SQL' => [ + 'description' => '由审计日志组成的集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HostAddress' => [ + 'description' => '客户端地址。', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + 'SQLText' => [ + 'description' => '命令记录。', + 'type' => 'string', + 'example' => 'CONFIG GET maxmemory', + ], + 'DatabaseName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'demo', + ], + 'SQLType' => [ + 'description' => '命令类型。', + 'type' => 'string', + 'example' => 'non_read_write', + ], + 'ExecuteTime' => [ + 'description' => '执行时间。', + 'type' => 'string', + 'example' => '2019-03-25T03:22:08Z', + ], + 'TotalExecutionTimes' => [ + 'description' => '执行消耗时间。', + 'type' => 'string', + 'example' => '0', + ], + 'NodeId' => [ + 'description' => '节点ID。'."\n" + .'> 实例为集群或读写分离架构时，本参数才会返回具体的节点ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****-db-0', + ], + 'AccountName' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'demo', + ], + 'IPAddress' => [ + 'description' => 'IP地址。', + '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' => '查询实例的审计日志', + 'description' => '调用本接口时，实例必须已开启审计日志，详情请参见[ModifyAuditLogConfig](~~473829~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRunningLogRecords' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的运行日志。', + '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' => '需要查询的实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例中的节点ID。传入本参数可查询指定节点的运行日志。'."\n" + ."\n" + .'> * 当实例的架构为读写分离或集群架构时，本参数才可用。'."\n" + .'> * 如需传入本参数，您还需要传入**CharacterType**参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****-db-0', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，您可以查看72小时内的运行日志，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2018-12-03T07:01Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，必须晚于查询开始时间，且起止时间的范围不能超过1天（推荐范围为1小时），格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2018-12-03T08:01Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据分片的角色类型，取值：'."\n" + .'* **master**（默认）：主节点。'."\n" + .'* **slave**：备节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'master', + 'default' => 'master', + 'enum' => [ + 'master', + 'primary', + 'secondary', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页可展示的最大记录数，取值： **30**、**50**、**100**，默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于**0**且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群实例的分片类型，取值：'."\n" + .'* **proxy**：代理节点。'."\n" + .'* **db**：数据节点。'."\n" + .'* **cs**：config server节点。'."\n" + ."\n" + .'> 传入本参数后，您还需要传入**NodeId**参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'proxy', + 'enum' => [ + 'proxy', + 'db', + 'cs', + ], + ], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询运行日志的关键词。', + 'type' => 'string', + 'required' => false, + 'example' => 'aof', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果的排序方式，取值：'."\n" + .'* **asc**：表示顺序'."\n" + .'* **desc**：表示倒序', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'default' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '查询开始时间。', + 'type' => 'string', + 'example' => '2018-12-03T07:01Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '093B8579-9264-43A0-ABA9-AA86****', + ], + 'PageRecordCount' => [ + 'description' => '当前页显示的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageSize' => [ + 'description' => '每页最大记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'Engine' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'Redis', + ], + 'PageNumber' => [ + 'description' => '当前显示的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogRecords' => [ + 'description' => '日志详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '日志生成时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2018-12-03T07:07:30Z', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'Content' => [ + 'description' => '日志内容。', + 'type' => 'string', + 'example' => 'CONFIG REWRITE executed with success.', + ], + 'NodeId' => [ + 'description' => '节点ID。'."\n" + .'> 实例为标准架构时，本参数返回`(null)`。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****-db-0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询实例的运行日志列表', + 'description' => '该API对应的控制台操作请参见[查询运行日志](~~101713~~)。'."\n" + .'DescribeRunningLogRecords的调用频率上限为100次/分钟。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSlowLogRecords' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例在指定时间内产生的慢日志。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例中的节点ID。传入本参数可查询指定节点的慢日志信息。'."\n" + .'> 当实例的架构为读写分离或集群架构时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****-db-0', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-03-10T14:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，必须晚于查询开始时间，且起止时间的范围不能超过1天（推荐范围为1小时），格式为yyyy-MM-ddTHH:mmZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-03-10T15:00Z', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页可展示的最大记录数，取值：**30**、**50**、**100**，默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值为大于**0**且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'SlowLogRecordType', + 'in' => 'query', + 'schema' => [ + 'description' => '慢日志类型，取值：'."\n" + .'* **proxy**：代理节点中的慢日志。'."\n" + .'* **db**：默认值，数据节点中的慢日志。', + 'type' => 'string', + 'required' => false, + 'example' => 'proxy', + 'default' => 'db', + 'enum' => [ + 'proxy', + 'db', + ], + ], + ], + [ + 'name' => 'QueryKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => '可设置一个字符串类型的值，使用该值作为关键词对返回结果进行搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'keyword1', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果的排序方式，取值：'."\n" + .'* **ASC**：升序。'."\n" + .'* **DESC**：默认值，降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + 'default' => 'DESC', + 'enum' => [ + 'ASC', + 'DESC', + ], + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果的排序依据，取值：'."\n" + .'* **execution_time**：默认值，按照请求的执行开始时间排序。'."\n" + .'* **latency**：按照请求的执行耗时排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'execution_time', + 'default' => 'execution_time', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '查询的开始时间。', + 'type' => 'string', + 'example' => '2019-03-10T14:00Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '686BB8A6-BBA5-47E5-8A75-D2ADE433****', + ], + 'PageRecordCount' => [ + 'description' => '当前页显示的日志数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalRecordCount' => [ + 'description' => '日志条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的日志数上限。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp10n********', + ], + 'Engine' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'Redis', + ], + 'PageNumber' => [ + 'description' => '当前显示的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogRecords' => [ + 'description' => '由慢日志信息组成的集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => '账号ID。', + 'type' => 'string', + 'example' => '0', + ], + 'ElapsedTime' => [ + 'description' => '执行时长，单位为微秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '248', + ], + 'Command' => [ + 'description' => '慢查询语句。', + 'type' => 'string', + 'example' => 'KEYS *', + ], + 'DBName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => '0', + ], + 'ExecuteTime' => [ + 'description' => '执行开始时间，格式：YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2019-03-12T09:18:41Z', + ], + 'DataBaseName' => [ + 'description' => '数据库名称，与**DBName**作用一致，推荐使用**DBName**参数。', + 'type' => 'string', + 'example' => '0', + ], + 'NodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****-db-0', + ], + 'AccountName' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'demo', + ], + 'IPAddress' => [ + 'description' => '客户端的IP地址。', + 'type' => 'string', + 'example' => '172.16.88.***', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看慢日志明细', + 'description' => '该API对应的控制台操作请参见[查询慢日志](~~95874~~)。'."\n" + .'DescribeSlowLogRecords的调用频率上限为100次/分钟。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'InitializeKvstorePermission' => [ + 'summary' => '为云数据库 Tair（兼容 Redis）授权服务关联角色。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5D622714-AEDD-4609-9167-F5DDD3D2****', + ], + ], + ], + ], + ], + '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' => '授权服务关联角色', + 'description' => '由于云数据库 Tair（兼容 Redis）的日志管理功能需要使用[日志服务](~~48869~~)的相关资源，使用日志管理功能前，您需要调用本接口将名称为AliyunServiceRoleForKvstore的关联角色授权给云数据库 Tair（兼容 Redis）使用。更多信息，请参见[云数据库 Tair（兼容 Redis）服务关联角色](~~184337~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeServiceLinkedRoleExists' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）是否已授权服务关联角色。', + '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' => '实例所属的地域ID。'."\n" + .'> 该参数不影响查询结果，配置任意地域即可', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型。仅支持传入“Redis”或不传本参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'Redis', + 'default' => 'Redis', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ExistsServiceLinkedRole' => [ + 'description' => '当前账号是否已经开通了角色。返回值：'."\n" + ."\n" + .'- **true**：已开通。'."\n" + ."\n" + .'- **false**：未开通。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90B82DB7-FB28-4CC2-ADBF-1F8659F3****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ExistsServiceLinkedRole\\": true,\\n \\"RequestId\\": \\"90B82DB7-FB28-4CC2-ADBF-1F8659F3****\\"\\n}","type":"json"}]', + 'title' => '查询服务关联角色授权', + 'description' => '调用本接口可查询本账号下名称为AliyunServiceRoleForKvstore的关联角色是否已经授权给云数据库 Tair（兼容 Redis）使用。更多信息，请参见[云数据库 Tair（兼容 Redis）服务关联角色](~~184337~~)。', + ], + 'ModifySecurityIps' => [ + 'summary' => '设置云数据库 Tair（兼容 Redis）实例的IP白名单。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'SecurityIps', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单分组下的IP列表，最多1000个。IP之间以逗号隔开，格式如下：0.0.0.0/0,10.23.12.24，或者10.23.12.24/24（CIDR模式，无类域间路由，/24表示地址中前缀的长度，范围1-32）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100.64.***.0/24,10.101.11.***', + ], + ], + [ + 'name' => 'SecurityIpGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单分组的名称。'."\n" + .'不可修改系统生成白名单分组。如果不传此字段，将默认修改 default 分组的白名单', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'SecurityIpGroupAttribute', + 'in' => 'query', + 'schema' => [ + 'description' => '默认为空。用于区分不同的属性值，控制台将不显示该值为**hidden**的白名单分组。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'hidden', + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => '修改方式，取值：'."\n" + .'* **Cover**（默认）：覆盖原白名单。'."\n" + .'* **Append**：追加白名单。'."\n" + .'* **Delete**：删除该白名单。', + 'type' => 'string', + 'required' => false, + 'example' => 'Append', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改IP白名单', + 'description' => '该API对应的控制台操作请参见[设置IP白名单](~~56464~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifySecurityGroupConfiguration' => [ + 'summary' => '设置云数据库 Tair（兼容 Redis）实例白名单中的安全组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '56499', + 'abilityTreeNodes' => [ + 'FEATUREkvstoreN9BAYI', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待设置的安全组ID。最多可传入10个，安全组ID之间用英文逗号（,）分隔。'."\n" + .'> 将覆盖原设置，取值参考查询您创建的安全组的基本信息[DescribeSecurityGroups](https://next.api.aliyun.com/api/Ecs/2014-05-26/DescribeSecurityGroups)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sg-bpcfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '设置实例白名单中的安全组', + 'description' => '调用本接口会覆盖实例白名单中原有的安全组，并将**SecurityGroupId**参数中指定的安全组加入至白名单。该API对应的控制台操作请参见[添加安全组](~~148267~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyInstanceSSL' => [ + 'summary' => '为云数据库 Tair（兼容 Redis）实例开启TLS（Transport Layer Security）加密协议配置。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'SSLEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '修改TLS（SSL）设置，取值：'."\n" + .'* **Disable**：关闭。'."\n" + .'* **Enable**：开启。'."\n" + .'* **Update**：更新证书。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Enable', + 'enum' => [ + 'Disable', + 'Enable', + 'Update', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AD7E16AA-6B23-43BF-979C-07D957FB****', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '32184****', + ], + ], + ], + ], + ], + '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' => '修改TLS（SSL）配置', + 'description' => '该API对应的控制台操作请参见[设置SSL加密](~~84898~~)。'."\n" + .'> 如需指定SSL最低版本，您可以调用[ModifyInstanceConfig](~~473844~~)接口通过修改参数来实现。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyInstanceVpcAuthMode' => [ + 'summary' => '开启或关闭专有网络免密访问。开启后，同一专有网络内的云服务器无需使用密码即可连接云数据库 Tair（兼容 Redis）实例，同时也继续兼容通过用户名和密码的方式连接实例。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'VpcAuthMode', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络下的认证模式，取值：'."\n" + .'* **Open**：通过密码认证。'."\n" + .'* **Close**：关闭密码认证，即开启免密访问。'."\n" + ."\n" + .'> 默认值为**Open**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Close', + 'enum' => [ + 'Open', + 'Close', + 'OPEN', + 'CLOSE', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改专有网络免密访问设置', + 'description' => '本接口的控制台操作请参见[开启免密访问](~~85168~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSecurityIps' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的IP白名单。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EFC9161F-15E3-4A6E-8A99-C09916D1****', + ], + 'SecurityIpGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SecurityIpGroup' => [ + 'description' => '实例的IP白名单分组信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的IP白名单分组信息。', + 'type' => 'object', + 'properties' => [ + 'SecurityIpGroupAttribute' => [ + 'description' => 'IP白名单分组属性，默认为空。'."\n" + .'> **hidden**分组表示经用户授权后，系统（DAS、DMS、DTS等）自动生成的白名单分组，此类白名单分组不支持修改、删除操作。 ', + 'type' => 'string', + 'example' => 'hidden', + ], + 'SecurityIpList' => [ + 'description' => 'IP白名单分组下的IP列表，最多1000个。', + 'type' => 'string', + 'example' => '100.100.202.***/24,10.10.10.***', + ], + 'SecurityIpGroupName' => [ + 'description' => 'IP白名单分组的名称。', + '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' => '查询实例的IP白名单', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSecurityGroupConfiguration' => [ + 'summary' => '查看云数据库 Tair（兼容 Redis）白名单中设置的安全组。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '981C0D6A-D9DD-466C-92DA-F29DF755****', + ], + 'Items' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EcsSecurityGroupRelation' => [ + 'description' => '安全组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组列表。', + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-bp14p9y07ns3gwq****', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'NetType' => [ + 'description' => '安全组的网络类型，返回值：'."\n" + .'* **classic**：经典网络。'."\n" + .'* **vpc**：专有网络。', + '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' => '查询已配置的安全组', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceSSL' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例是否开启了TLS（SSL）加密认证。', + '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' => '实例 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '02260F96-913E-4655-9BA5-A3651CAF****', + ], + 'SSLEnabled' => [ + 'description' => 'TLS（SSL）加密功能的状态：'."\n" + .'* **Enable**：已开启。'."\n" + .'* **Disable**：未开启。', + 'type' => 'string', + 'example' => 'Enable', + ], + 'SSLExpiredTime' => [ + 'description' => 'CA证书的过期时间。', + 'type' => 'string', + 'example' => '2020-08-05T09:05:53Z', + ], + 'CertCommonName' => [ + 'description' => 'CA证书的公共名，默认值为实例的内网连接地址。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com', + ], + 'CertDownloadURL' => [ + 'description' => 'CA证书的下载链接。', + 'type' => 'string', + 'example' => 'https://apsaradb-public.oss-ap-sout****-1.aliy****.com/ApsaraDB-CA-Chain.zip', + ], + ], + ], + ], + ], + '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' => '查询是否开启TLS（SSL）加密', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyInstanceConfig' => [ + 'summary' => '修改云数据库 Tair（兼容 Redis）实例的参数配置。', + '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' => '修改实例的参数配置', + ], + 'DescribeParameterTemplates' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例在不同架构和大版本下的参数列表和默认值。', + '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' => '实例的架构，更多信息，请参见[架构介绍](~~86132~~)。取值：'."\n" + .'* **logic**：集群或读写分离架构。'."\n" + .'* **normal**：标准架构（主备）。'."\n" + ."\n" + .'当**EngineVersion**取值为**6.0**时，本参数不支持传入**logic**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'logic', + 'enum' => [ + 'logic', + 'normal', + ], + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型，取值固定为**Redis**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Redis', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的大版本，取值：**4.0**、**5.0**、**6.0**或**7.0**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5.0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。您可以通过调用[ListResourceGroups](~~158855~~)接口获取资源组ID。'."\n" + .'> 您也可以通过控制台获取资源组ID，相关操作，请参见[查看资源组基本信息](~~151181~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9DA28D8E-514D-4F12-ADED-70A9C818****', + ], + 'Engine' => [ + 'description' => '数据库类型，返回值固定为**Redis**。', + 'type' => 'string', + 'example' => 'redis', + ], + 'EngineVersion' => [ + 'description' => '实例的大版本。', + 'type' => 'string', + 'example' => '5.0', + ], + 'ParameterCount' => [ + 'description' => '参数个数。', + 'type' => 'string', + 'example' => '24', + ], + 'Parameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateRecord' => [ + 'description' => '参数的详细信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => '参数值的可选范围。', + 'type' => 'string', + 'example' => '[yes|no]', + ], + 'ParameterName' => [ + 'description' => '参数名，更多关于参数作用的介绍和设置说明，请参见[参数说明](~~259681~~)。', + 'type' => 'string', + 'example' => 'appendonly', + ], + 'ParameterValue' => [ + 'description' => '参数默认值。', + 'type' => 'string', + 'example' => 'yes', + ], + 'ForceModify' => [ + 'description' => '参数是否可修改，返回值：'."\n" + .'* **true**：可修改。'."\n" + .'* **false**：不可修改。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ForceRestart' => [ + 'description' => '参数修改后，是否需要重启生效，返回值：'."\n" + .'* **true**：需要重启生效。'."\n" + .'* **false**：修改后立即生效，无需重启。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ParameterDescription' => [ + 'description' => '参数描述。', + 'type' => 'string', + 'example' => '开启aof持久化模式', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询参数列表和默认值', + 'description' => '调用本接口查询到参数列表和默认值后，您还可以根据业务需求调用[ModifyInstanceConfig](~~473844~~)接口修改Redis实例的参数。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceConfig' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的部分默认配置参数信息。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => '实例的默认配置参数，更全面的参数配置请调用[Describeparamters](~~473847~~)接口。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '4E2C08F6-2D11-4ECD-9A4C-27EF2D3D****', + ], + 'ParamReplMode' => [ + 'description' => '同步模式：'."\n" + .'* **async**（默认）：异步模式'."\n" + .'* **semisync**：半同步模式', + 'type' => 'string', + 'example' => 'async', + ], + 'ParamReplTimeout' => [ + 'description' => '半同步模式的降级阈值。仅半同步支持配置该参数，单位为ms，取值范围为10~60000，默认为500。'."\n" + .'> 当同步延迟超出该阈值时，同步模式会自动转为异步，当同步延迟消除后，同步模式会自动转换为半同步。', + 'type' => 'string', + 'example' => '500', + ], + 'ParamNoLooseSentinelEnabled' => [ + 'description' => '哨兵兼容模式，适用于非集群实例。取值说明：'."\n" + .'* **no**（默认）：未开启'."\n" + .'* **yes**：开启'."\n" + .'> 更多信息请参见[Sentinel兼容模式](~~178911~~)。', + 'type' => 'string', + 'example' => 'no', + ], + 'ParamSentinelCompatEnable' => [ + 'description' => '哨兵兼容模式，适用于集群架构代理连接模式或读写分离架构的实例，取值说明：'."\n" + .'* **0**（默认）：未开启'."\n" + .'* **1**：开启'."\n" + .'> 更多信息请参见[Sentinel兼容模式](~~178911~~)。', + 'type' => 'string', + 'example' => '0', + ], + 'ParamNoLooseSentinelPasswordFreeAccess' => [ + 'description' => '开启哨兵模式时，是否允许免密执行Sentinel相关命令，取值说明：'."\n" + .'* **no**（默认）：关闭。'."\n" + .'* **yes**：开启。开启后，可以在任意连接上免密执行Sentinel命令以及使用SENTINEL命令监听+switch-master通道。', + 'type' => 'string', + 'example' => 'no', + ], + 'ParamNoLooseSentinelPasswordFreeCommands' => [ + 'description' => '启用哨兵模式及ParamNoLooseSentinelPasswordFreeAccess参数后，可通过本参数添加额外的免密命令列表（默认为空）。', + 'type' => 'string', + 'example' => '****', + ], + ], + ], + ], + ], + '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' => '查询实例参数配置', + 'description' => '本接口仅支持查询云原生版实例。'."\n" + .'> 若实例为经典版，您可以通过[DescribeParameters](~~473847~~)接口进行查询。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeParameters' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的配置参数和运行参数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '56422', + 'abilityTreeNodes' => [ + 'FEATUREkvstore9GDS4D', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，可调用[DescribeRegions](~~473763~~)查询，使用此参数指定要创建实例的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '节点ID。'."\n" + .'> 传入本参数可查询集群实例中指定节点的参数配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1xxxxxxxxxxxxx-db-0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9C1338BE-8DE8-4890-A900-E1BC06BF****', + ], + 'Engine' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'redis', + ], + 'EngineVersion' => [ + 'description' => '数据库版本号。', + 'type' => 'string', + 'example' => '4.0', + ], + 'ConfigParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Parameter' => [ + 'description' => '未生效的配置参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => '校验代码，参数的可选范围。', + 'type' => 'string', + 'example' => '[0|1]', + ], + 'ParameterName' => [ + 'description' => '参数名。', + 'type' => 'string', + 'example' => 'script_check_enable', + ], + 'ParameterValue' => [ + 'description' => '参数的值。', + 'type' => 'string', + 'example' => '1', + ], + 'ForceRestart' => [ + 'description' => '是否需要重启生效，返回值：'."\n" + .'* **True**：重启生效。'."\n" + .'* **False**：无需重启，提交后即生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ParameterDescription' => [ + 'description' => '参数的描述。', + 'type' => 'string', + 'example' => 'Check all keys passed in the KEYS array map to the same slot.', + ], + 'ModifiableStatus' => [ + 'description' => '参数是否可修改，返回值：'."\n" + .'* **False**：不可修改。'."\n" + .'* **True**：可修改。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'RunningParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Parameter' => [ + 'description' => '运行参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'CheckingCode' => [ + 'description' => '参数的可选范围。', + 'type' => 'string', + 'example' => '[0|1]', + ], + 'ParameterName' => [ + 'description' => '参数名。', + 'type' => 'string', + 'example' => '#no_loose_disabled-commands', + ], + 'ParameterValue' => [ + 'description' => '参数的值。', + 'type' => 'string', + 'example' => 'keys,flushall,flushdb', + ], + 'ForceRestart' => [ + 'description' => '是否需要重启生效，返回值：'."\n" + .'* **True**：重启生效。'."\n" + .'* **False**：无需重启，提交后即生效。', + 'type' => 'string', + 'example' => 'true', + ], + 'ParameterDescription' => [ + 'description' => '参数的描述。', + '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' => '参数是否可修改，返回值：'."\n" + .'* **False**：不可修改。'."\n" + .'* **True**：可修改。', + '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' => '查询实例的配置参数和运行参数', + 'description' => '本接口仅支持查询经典版实例。'."\n" + .'> 若实例为云原生版，您可以通过[DescribeInstanceConfig](~~473846~~)接口进行查询。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeParameterModificationHistory' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的参数修改历史。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '56421', + 'abilityTreeNodes' => [ + 'FEATUREkvstore9GDS4D', + 'FEATUREkvstoreDVVZYL', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，可调用[DescribeInstances](~~473778~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '节点ID。'."\n" + .'> 传入本参数可查询集群实例中指定节点的参数配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1xxxxxxxxxxxxx-db-0', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-09-05T08:49:27Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-09-05T09:49:27Z', + ], + ], + [ + 'name' => 'ParameterName', + 'in' => 'query', + 'schema' => [ + 'description' => '参数名。', + 'type' => 'string', + 'required' => false, + 'example' => 'script_check_enable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '963C20F0-7CE1-4591-AAF3-6F3CD1CE****', + ], + 'HistoricalParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'HistoricalParameter' => [ + 'description' => '参数的修改记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '参数的修改记录列表。', + 'type' => 'object', + 'properties' => [ + 'OldParameterValue' => [ + 'description' => '变更前的参数值。', + 'type' => 'string', + 'example' => '-2', + ], + 'ParameterName' => [ + 'description' => '参数名。', + 'type' => 'string', + 'example' => 'script_check_enable', + ], + 'NewParameterValue' => [ + 'description' => '变更后的参数值。', + 'type' => 'string', + 'example' => '0', + ], + 'ModifyTime' => [ + 'description' => '修改时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2022-09-05T09:56:10Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询参数修改历史', + ], + 'ListTagResources' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例和标签的绑定关系。', + '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' => '实例所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值固定为**INSTANCE**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'INSTANCE', + 'enum' => [ + 'INSTANCE', + 'instance', + ], + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始Token，用来返回更多结果。'."\n" + .'> 第一次查询不需要提供本参数，如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的**NextToken**值以继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707ec2****', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例ID列表。'."\n" + ."\n" + .'> * 本参数和**Tag**参数两者中必须传入一项。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例的标签信息。本参数和**ResourceId**参数两者中必须传入一项。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键。', + 'type' => 'string', + 'required' => false, + 'example' => 'demokey', + ], + 'Value' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'demovalue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的token继续查询。', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707ec2****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '47A514A1-4B77-4E30-B4C5-2A880650****', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '实例和标签的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => 'demovalue', + ], + 'ResourceType' => [ + 'description' => '资源类型。返回值固定为**ALIYUN::KVSTORE::INSTANCE**，即云数据库 Tair（兼容 Redis）实例。', + 'type' => 'string', + 'example' => 'ALIYUN::KVSTORE::INSTANCE', + ], + 'ResourceId' => [ + 'description' => '资源ID，即实例的ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'TagKey' => [ + 'description' => '标签的键。', + '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' => '查询标签列表', + 'description' => '该API对应的控制台操作请参见[根据标签筛选实例](~~119160~~)和[查看实例绑定的标签](~~134038~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'summary' => '为一个或多个云数据库 Tair（兼容 Redis）实例绑定标签。', + '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' => '实例所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值固定为**INSTANCE**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'INSTANCE', + 'enum' => [ + 'INSTANCE', + 'instance', + ], + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID，支持设置多个。'."\n" + .'> **N**表示传入第几个实例ID。例如**ResourceId.1**表示传入第一个实例ID；**ResourceId.2**表示传入第二个实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'required' => true, + 'example' => 'r-bp1zxszhcgatnx****', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例的标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键。'."\n" + ."\n" + .'> * **N**表示传入第几个标签的键。例如**Tag.1.Key**表示传入第一个标签的键；**Tag.2.Key**表示传入第二个标签的键。'."\n" + .'> * 如果标签的键不存在，则自动创建。', + 'type' => 'string', + 'required' => true, + 'example' => 'demokey', + ], + 'Value' => [ + 'description' => '标签的值。'."\n" + ."\n" + .'> **N**表示传入第几个标签的值。例如**Tag.1.Value**表示传入第一个标签的值；**Tag.2.Value**表示传入第二个标签的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'demovalue', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '为一个或多个实例绑定标签', + 'description' => '在实例数量较多的情况下，您可以创建多个标签，为实例绑定不同的标签对其进行分类，之后通过标签进行实例筛选。'."\n" + ."\n" + .'* 标签由一对键（key）值（value）组成，键在同账号同地域下唯一，值无此限制。'."\n" + .'* 若设置的标签不存在，则自动创建该标签并绑定到目标实例。'."\n" + .'* 若实例已经绑定了有相同键的标签，则进行覆盖绑定。'."\n" + .'* 每个实例最多可以绑定20个标签。'."\n" + .'* 每次调用最多设置50个实例进行批量标签绑定。'."\n" + ."\n" + .'该API对应的控制台操作请参见[新建标签](~~118779~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UntagResources' => [ + 'summary' => '将标签从云数据库 Tair（兼容 Redis）实例解绑。', + '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' => '地域ID，可调用[DescribeRegions](~~473763~~)查询。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值：**INSTANCE**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'INSTANCE', + 'enum' => [ + 'INSTANCE', + 'instance', + ], + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否解绑实例上的所有标签，取值：'."\n" + .'* **true**：解绑实例上的所有标签。'."\n" + .'* **false**：不解绑实例上的所有标签，默认值。'."\n" + ."\n" + .'> 如果同时设置了**TagKey.N**和本参数，则本参数不生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'required' => true, + 'example' => 'r-bp1zxszhcgatnx****', + 'maxItems' => 51, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'demokey', + ], + 'required' => false, + 'example' => 'demokey', + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '为实例解绑标签', + 'description' => '* 每次解绑的标签数量不能超过20个；'."\n" + .'* 标签从一个实例解绑后，如果没有绑定到其它实例，则该标签自动被删除。'."\n" + ."\n" + .'该API对应的控制台操作请参见[解绑标签](~~119157~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateCacheAnalysisTask' => [ + 'summary' => '手动发起实例缓存分析任务。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '创建缓存分析任务', + 'description' => '本接口已不推荐使用，请使用新接口[实时Top Key统计与离线全量Key分析](~~184226~~)。', + ], + 'DescribeCacheAnalysisReport' => [ + 'summary' => '查看实例在指定日期中的缓存分析报告。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的日期，每次可查询一天的离线全量Key分析结果，格式为yyyy-MM-ddZ（UTC时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-08-05Z', + ], + ], + [ + 'name' => 'AnalysisType', + 'in' => 'query', + 'schema' => [ + 'description' => '分析类型，取值固定为**BigKey**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'BigKey', + 'enum' => [ + 'HotKey', + 'BigKey', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的记录数，取值：**30**、**50**或**100**。'."\n" + .'> 默认值：**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + ], + ], + [ + 'name' => 'PageNumbers', + 'in' => 'query', + 'schema' => [ + 'description' => '需要返回的页码。'."\n" + .'> 如果该值大于返回结果的最大页数，则返回的大key结果为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群版实例的子节点ID。'."\n" + .'> 集群版必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****-db-0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的最大记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A057C066-C3F5-4CC9-9FE4-A8D8B0DC****', + ], + 'PageRecordCount' => [ + 'description' => '当前页显示的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalRecordCount' => [ + 'description' => '所有页的记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '160', + ], + 'BigKeys' => [ + 'description' => '大key列表。', + 'type' => 'array', + 'items' => [ + 'description' => '大key。', + 'type' => 'object', + 'example' => '[{"db": "0", "qps": 0, "keyType": "list", "isExpired": "no", "analysisType": "BIGKEY", "key": "mylist", "memory": 1005377, "size": 200000}]', + ], + ], + 'HotKeys' => [ + 'description' => '热点key列表。'."\n" + .'> 暂不支持热点key分析，无返回值。', + 'type' => 'array', + 'items' => [ + 'description' => '热点key。', + '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' => '查看实例缓存分析报告', + 'description' => '本接口已不推荐使用，请使用新接口[实时Top Key统计与离线全量Key分析](~~184226~~)。', + ], + 'DescribeCacheAnalysisReportList' => [ + 'summary' => '查询实例的缓存分析报告列表。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Days', + 'in' => 'query', + 'schema' => [ + 'description' => '查询最近几天内的分析结果，默认查询最近7天的分析结果。'."\n" + ."\n" + .'> 如果查询时当日的自动分析尚未开始，且没有手动发起分析任务，则本日没有记录。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的记录数，取值**30**、**50**或**100**。'."\n" + .'> 默认值：**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + 'enum' => [ + '30', + '50', + '100', + ], + ], + ], + [ + 'name' => 'PageNumbers', + 'in' => 'query', + 'schema' => [ + 'description' => '需要返回的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群版实例的子节点ID。'."\n" + ."\n" + .'> 如果不设置将返回所有子节点的分析结果。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****-db-0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => '1041xxxx', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '743D0A03-52DE-4E6F-8D09-EC1414CF****', + ], + 'DailyTasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DailyTask' => [ + 'description' => '离线全量Key分析报告列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => '离线全量Key分析发起的日期。', + 'type' => 'string', + 'example' => '2019-08-01Z', + ], + 'Tasks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Task' => [ + 'description' => '离线全量Key分析报告。', + 'type' => 'array', + 'items' => [ + 'description' => '离线全量Key分析报告。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '离线全量Key分析任务的状态，返回值：'."\n" + .'* **success**：成功。'."\n" + .'* **running**：进行中。', + 'type' => 'string', + 'example' => 'success', + ], + 'StartTime' => [ + 'description' => '离线全量Key分析任务的开始时间。', + 'type' => 'string', + 'example' => '2019-08-01T19:08:49Z', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '156465****', + ], + 'NodeId' => [ + 'description' => '集群版实例的子节点ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****-db-0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询实例的缓存分析报告列表', + 'description' => '本接口已不推荐使用，请使用新接口[实时Top Key统计与离线全量Key分析](~~184226~~)。', + ], + 'ModifyInstanceTDE' => [ + 'summary' => '为云数据库 Tair（兼容 Redis）实例开启透明数据加密TDE功能，支持自定义密钥。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'TDEStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '开启TDE功能，取值：**Enabled**。'."\n" + .'> TDE功能开启后暂不支持关闭，开启前请评估是否影响业务。更多信息，请参见[开启透明数据加密TDE](~~265913~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Enabled', + ], + ], + [ + 'name' => 'EncryptionName', + 'in' => 'query', + 'schema' => [ + 'description' => '加密算法，默认AES-CTR-256。'."\n" + .'> 当**TDEStatus**参数取值为**Enabled**时，本参数才可用。', + 'type' => 'string', + 'required' => false, + 'example' => 'AES-CTR-256', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义密钥ID，您可以调用[DescribeEncryptionKeyList](~~473860~~)获取。'."\n" + ."\n" + .'> * 如果不传入本参数，则由[密钥管理服务](~~28935~~)自动生成密钥。'."\n" + .'> * 如需创建自定义密钥，您可以调用密钥管理服务的[CreateKey](~~28947~~)接口。', + 'type' => 'string', + 'required' => false, + 'example' => 'ad463061-992d-4195-8a94-ed63********', + ], + ], + [ + 'name' => 'RoleArn', + 'in' => 'query', + 'schema' => [ + 'description' => '指定待授权角色的全局资源描述符ARN（Alibaba Cloud Resource Name）信息，完成授权后即可使用相关密钥管理服务，格式：`acs:ram::$accountID:role/$roleName` 。'."\n" + ."\n" + .'> * `$accountID`：云账号ID。您可以登录阿里云控制台，将鼠标悬停在右上角头像的位置，单击**安全设置**进行查看。'."\n" + .'> * `$roleName`：RAM角色名称，取值固定为：**AliyunRdsInstanceEncryptionDefaultRole**。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '开启透明数据加密TDE', + 'description' => '> 关于透明数据加密TDE（Transparent Data Encryption）的详细介绍及开启后的影响，请参见[开启透明数据加密TDE](~~265913~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceTDEStatus' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例是否开启了TDE加密功能。', + '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' => '实例ID，可调用 [DescribeInstances](~~473778~~) 获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TDEStatus' => [ + 'description' => 'TDE加密功能是否开启，返回值：'."\n" + .'* **Enabled**：开启。'."\n" + .'* **Disabled**：关闭。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '查询实例是否开启TDE加密', + 'description' => '关于透明数据加密TDE（Transparent Data Encryption）的详细介绍及注意事项，请参见[开启透明数据加密TDE](~~265913~~)。'."\n" + .'> 您可以调用[ModifyInstanceTDE](~~473859~~)开启或关闭TDE加密功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeEncryptionKeyList' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例使用的自定义密钥列表。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '10E2160B-959C-5C3E-BFE6-86EC5925****', + ], + 'KeyIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'KeyId' => [ + 'description' => '该地域下可使用的自定义密钥的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义密钥。', + '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' => '查询实例的自定义密钥列表', + 'description' => '* 调用[ModifyInstanceTDE](~~473859~~)开启透明数据加密TDE时，可使用自定义密钥，本接口可帮助您查询实例已使用的自定义密钥。如需创建自定义密钥，请调用密钥管理服务的[CreateKey](~~28947~~)接口。'."\n" + .'* 关于透明数据加密TDE的详细介绍及注意事项，请参见[开启透明数据加密TDE](~~265913~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeEncryptionKey' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的透明数据加密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' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'EncryptionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的自定义密钥ID，可调用[DescribeEncryptionKeyList](~~473860~~)接口查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'ad463061-992d-4195-8a94-ed63********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DeleteDate' => [ + 'description' => '实例密钥的预计删除时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'> 本参数返回内容为空时，表示密钥不会被自动删除。', + 'type' => 'string', + 'example' => '2021-09-24T18:22:03Z', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9A931CE5-C926-5E09-B0EC-6299C4A6****', + ], + 'Description' => [ + 'description' => '密钥的描述信息，默认为空。', + 'type' => 'string', + 'example' => 'testkey', + ], + 'Origin' => [ + 'description' => '密钥材料的来源，返回值**Aliyun_KMS**，即表示阿里云[密钥管理服务KMS](~~28935~~)。', + 'type' => 'string', + 'example' => 'Aliyun_KMS', + ], + 'MaterialExpireTime' => [ + 'description' => '密钥的过期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'> 本参数返回内容为空时，表示密钥不会过期。', + 'type' => 'string', + 'example' => '2021-09-24T18:22:03Z', + ], + 'EncryptionKeyStatus' => [ + 'description' => '实例的密钥状态，返回值：'."\n" + .'* **Enabled**：可用。'."\n" + .'* **Disabled**：不可用。', + 'type' => 'string', + 'example' => 'Enabled', + ], + 'KeyUsage' => [ + 'description' => '实例密钥的用途，返回值`ENCRYPT/DECRYPT`即表示加密和解密。', + 'type' => 'string', + 'example' => 'ENCRYPT/DECRYPT', + ], + 'EncryptionKey' => [ + 'description' => '实例的密钥ID。', + 'type' => 'string', + 'example' => 'ad463061-992d-4195-8a94-ed63********', + ], + 'Creator' => [ + 'description' => '密钥创建者的云账号ID。', + 'type' => 'string', + 'example' => '17649847********', + ], + 'EncryptionName' => [ + 'description' => '加密算法。', + 'type' => 'string', + 'example' => 'AES-CTR-256', + ], + 'RoleArn' => [ + 'description' => '指定待授权角色的全局资源描述符ARN（Alibaba Cloud Resource Name）信息。', + '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' => '查询实例的TDE自定义密钥详情', + 'description' => '调用本接口时，要求实例已通过自定义密钥的方式开启了数据加密TDE（Transparent Data Encryption）功能，相关接口，请参见[ModifyInstanceTDE](~~473859~~)。'."\n" + ."\n\n" + .'> 关于透明数据加密TDE的详细介绍及注意事项，请参见[开启透明数据加密TDE](~~265913~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CheckCloudResourceAuthorized' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例是否已被授权使用KMS密钥服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'RoleArn', + 'in' => 'query', + 'schema' => [ + 'description' => '指定待授权角色的全局资源描述符ARN（Alibaba Cloud Resource Name）信息，完成该角色的授权后即可使用相关密钥管理服务，格式：`acs:ram::$accountID:role/$roleName` 。'."\n" + ."\n" + .'> * `$accountID`：云账号ID。您可以登录阿里云控制台，将鼠标悬停在右上角头像的位置，单击**安全设置**进行查看。'."\n" + .'> * `$roleName`：RAM角色名称，取值固定为：**AliyunRdsInstanceEncryptionDefaultRole**。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AuthorizationState' => [ + 'description' => '授权状态，返回值：'."\n" + .'* **0**：未授权。'."\n" + .'* **1**：已授权。'."\n" + .'* **2**：未开通密钥管理服务，具体操作，请参见[开通密钥管理服务](~~153781~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '查询是否已授权KMS密钥', + 'description' => '* 关于透明数据加密TDE（Transparent Data Encryption）的详细介绍及注意事项，请参见[开启透明数据加密TDE](~~265913~~)。'."\n" + .'* 调用本接口确认已授权后，您可以调用[ModifyInstanceTDE](~~473859~~)接口开启TDE加密功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeActiveOperationTaskCount' => [ + 'summary' => '查询Tair实例的运维任务数量', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'default' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskCount' => [ + 'description' => '待处理的运维任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NeedPop' => [ + 'description' => '是否有需要弹窗通知用户操作的运维任务。返回值：'."\n" + .'- **0**：无弹窗'."\n" + .'- **1**：有弹窗', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D9F3768-EDA9-4811-943E-42C8006E****', + ], + ], + ], + ], + ], + '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' => '查询Tair实例的运维任务数量', + ], + 'DescribeHistoryTasks' => [ + 'summary' => '查看任务中心的任务列表。', + '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' => '待处理事件所属的地域ID，可调用[DescribeRegions](~~473763~~)查询。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，取值：10~100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果的页码。取值范围：正整数。 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '当前固定为Instance。', + 'type' => 'string', + 'required' => false, + 'example' => 'Instance', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态，用于选择对应状态的任务：'."\n" + .'- **Scheduled**：等待执行'."\n" + .'- **Running**：执行中'."\n" + .'- **Succeed**：执行成功'."\n" + .'- **Failed**：执行失败'."\n" + .'- **Cancelling**：正在终止'."\n" + .'- **Canceled**：已终止'."\n" + .'- **Waiting**：等待预设时间'."\n" + .'> 默认为空，表示全选，如需选择多个状态请用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'Scheduled', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，用于查询对应实例的任务，默认为空，表示不限制。如需查询多个实例请用英文逗号（,）分隔，最多支持30个。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-uf62br2491p5l****'."\n", + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID，用于查询已知ID的任务默认为空，表示不限制。如需查询多个请用英文逗号（,）分隔，最多支持30个。', + 'type' => 'string', + 'required' => false, + 'example' => 't-83br18hloy3faf****'."\n", + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，用于查询特定类型任务情况，默认为空，表示不限制，取值如下：'."\n" + .'- **ModifyInsSpec**：规格变更或迁移'."\n" + .'- **DeleteInsNode**：删除分片'."\n" + .'- **AddInsNode**：增加分片'."\n" + .'- **HaSwitch**：实例主备切换'."\n" + .'- **RestartIns**：重启实例'."\n" + .'- **CreateIns**：创建实例'."\n" + .'- **ModifyInsConfig**：配置变更'."\n" + .'> 如需查询多个请用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'ModifyInsSpec', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询任务的最早开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间），最早支持查询30天前的数据。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询任务的最晚开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间），需晚于任务的最早开始时间。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-02-02T11:31:03Z', + ], + ], + [ + 'name' => 'FromExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ToExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前显示的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', + ], + 'PageSize' => [ + 'description' => '每页显示的最大记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '不考虑分页因素，满足查询条件的总任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Items' => [ + 'description' => '任务对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务对象，格式是词典。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n" + .'- **Scheduled**：等待执行'."\n" + .'- **Running**：执行中'."\n" + .'- **Succeed**：执行成功'."\n" + .'- **Failed**：执行失败'."\n" + .'- **Cancelling**：正在终止'."\n" + .'- **Canceled**：已终止'."\n" + .'- **Waiting**：等待预设时间', + 'type' => 'string', + 'example' => 'Running', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 't-83br18hloy3faf****', + ], + 'CurrentStepName' => [ + 'description' => '当前执行的步骤名，如果为空代表任务未开始。', + 'type' => 'string', + 'example' => 'exec_task', + ], + 'StartTime' => [ + 'description' => '任务开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2022-02-03T11:31:03Z', + ], + 'EndTime' => [ + 'description' => '任务结束时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2022-02-03T12:06:17Z', + ], + 'TaskType' => [ + 'description' => '任务类型。'."\n" + .'- **ModifyInsSpec**：规格变更或迁移'."\n" + .'- **DeleteInsNode**：删除分片'."\n" + .'- **AddInsNode**：增加分片'."\n" + .'- **HaSwitch**：实例主备切换'."\n" + .'- **RestartIns**：重启实例'."\n" + .'- **CreateIns**：创建实例'."\n" + .'- **ModifyInsConfig**：配置变更', + 'type' => 'string', + 'example' => 'ModifyInsSpec', + ], + 'RemainTime' => [ + 'description' => '预估剩余执行时间，单位秒，0表示已执行完成。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'Progress' => [ + 'description' => '当前进度，范围为[0,100]。', + 'type' => 'number', + 'format' => 'float', + 'example' => '79.0', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'InstanceType' => [ + 'description' => '实例类型，固定为Instance。', + 'type' => 'string', + 'example' => 'Instance', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'dba-tair-test-qcloud', + ], + 'DbType' => [ + 'description' => 'DB类型，固定为redis。', + 'type' => 'string', + 'example' => 'redis', + ], + 'Product' => [ + 'description' => '产品，固定为kvstore。', + 'type' => 'string', + 'example' => 'kvstore', + ], + 'TaskDetail' => [ + 'description' => '任务详情，不同taskType对应不同的输出。', + 'type' => 'string', + 'example' => '{\\"callerUid\\":\\"test\\"}', + ], + 'ReasonCode' => [ + 'description' => '当前任务发起的原因。', + 'type' => 'string', + 'example' => '小版本升级', + ], + 'ActionInfo' => [ + 'description' => '允许的操作信息，具体使用时是根据currentStepName+status在此信息中匹配操作Action，如果未匹配到Action，代表任务当前状态不支持操作，示例：'."\n" + ."\n" + .'```'."\n" + .'{"steps": ['."\n" + .' {'."\n" + .' "step_name": "exec_task", // 步骤名, 与currentStepName匹配'."\n" + .' "action_info": { // 步骤支持的操作'."\n" + .' "Waiting": [ // 状态，与status匹配'."\n" + .' "modifySwitchTime" // 操作Action，可能多个，即代表支持多个操作'."\n" + .' ]'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "step_name": "init_task", // 步骤名'."\n" + .' "action_info": { // 步骤支持的操作'."\n" + .' "Running": [ // 状态'."\n" + .' "cancel", // 操作'."\n" + .' "pause"'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'系统可能支持的操作： '."\n" + .'* **retry**：重试'."\n" + .'* **cancel**：取消'."\n" + .'* **modifySwitchTime**：修改切换时间或恢复时间', + 'type' => 'string', + 'example' => '{"steps":[{"action_info":{"Waiting":["modifySwitchTime"]},"step_name":"exec_task"}]}', + ], + 'Uid' => [ + 'description' => '资源所属的用户ID。', + 'type' => 'string', + 'example' => '141345906006****', + ], + 'CallerSource' => [ + 'description' => '请求用户ID，callerSource为User时代表用户UID。', + 'type' => 'string', + 'example' => '141345906006****', + ], + 'CallerUid' => [ + 'description' => '请求来源。 '."\n" + .'* **System**：系统自动'."\n" + .'* **User**：用户', + 'type' => 'string', + 'example' => 'User', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询历史运维任务', + ], + 'DescribeHistoryTasksStat' => [ + 'summary' => '查询任务中心的任务统计。', + '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' => '待处理事件所属的地域 ID，您可以通过调用 DescribeRegions 接口进行查询。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态，用于选择对应状态的任务：'."\n" + .'- **Scheduled**：等待执行'."\n" + .'- **Running**：执行中'."\n" + .'- **Succeed**：执行成功'."\n" + .'- **Failed**：执行失败'."\n" + .'- **Cancelling**：正在终止'."\n" + .'- **Canceled**：已终止'."\n" + .'- **Waiting**：等待预设时间'."\n" + .'> 默认为空，表示全选，如需选择多个状态请用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'Scheduled', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务 ID，用于查询已知 ID 的任务。默认为空，表示不限制。如需查询多个请用英文逗号（,）分隔，最多支持 30 个。', + 'type' => 'string', + 'required' => false, + 'example' => 't-0mq1yyhm3ffl2bxxxx', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '查询开始时间，格式为yyyy-mm-ddthh:mmz（utc时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '查询结束时间，格式为yyyy-mm-ddthh:mmz（utc时间）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-02-02T11:31:03Z', + ], + ], + [ + 'name' => 'FromExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ToExecTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认0，表示不限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ABAF95F6-35C1-4177-AF3A-70969EBD****', + ], + 'Items' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务信息列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。'."\n" + .'- **Scheduled**：等待执行'."\n" + .'- **Running**：执行中'."\n" + .'- **Succeed**：执行成功'."\n" + .'- **Failed**：执行失败'."\n" + .'- **Cancelling**：正在终止'."\n" + .'- **Canceled**：已终止'."\n" + .'- **Waiting**：等待预设时间', + 'type' => 'string', + 'example' => 'Scheduled', + ], + 'TotalCount' => [ + 'description' => '任务总数量。', + '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' => '查询任务中心的任务统计', + ], + 'ModifyActiveOperationTask' => [ + 'summary' => '修改运维任务的计划切换时间。', + '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' => '运维任务ID，多个ID间使用英文逗号（,）分隔。'."\n" + .'> 您可以调用[DescribeActiveOperationTask](~~473865~~)获取运维任务ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '11111,22222', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '要设置的计划切换时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'> 不能晚于最晚操作时间，您可以调用[DescribeActiveOperationTask](~~473865~~)，通过返回参数**Deadline**的值来获取最晚操作时间。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-10-17T18:50:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => '运维任务ID，多个ID间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '11111,22222', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改运维任务的计划切换时间', + 'description' => '云数据库 Tair（兼容 Redis）实例的运维事件（如实例迁移、版本升级等）除了通过短信、语音、邮件或站内信通知之外，还会在控制台进行通知。除通过调用本接口修改计划切换时间以外，你还可以通过控制台来修改，具体操作，请参见[查询或管理待处理事件](~~187022~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeActiveOperationTask' => [ + 'summary' => '查询云数据库 Tair（兼容 Redis）实例的运维任务详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '56375', + 'abilityTreeNodes' => [ + 'FEATUREkvstoreAO067M', + ], + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '待处理事件所属的地域ID，可调用[DescribeRegions](~~473763~~)接口获取。'."\n" + .'> 取值为**all**表示所有地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'all', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，取值：'."\n" + ."\n" + .'- **rds\\_apsaradb\\_ha**：主备节点切换。'."\n" + .'- **rds\\_apsaradb\\_transfer**：实例迁移。'."\n" + .'- **rds\\_apsaradb\\_upgrade**：小版本升级。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds_apsaradb_ha', + ], + ], + [ + 'name' => 'IsHistory', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回历史任务，取值：'."\n" + .'* **0**：默认值，返回当前任务。'."\n" + .'* **1**：返回历史任务。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页可展示的最大记录数，取值需大于**10**，默认值为**30**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于**0**且不超过Integer数据类型的最大值，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2E1FF0CC-F42A-4B6F-A1F4-A17B1451****', + ], + 'PageSize' => [ + 'description' => '每页可展示的最大记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalRecordCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '运维任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态，返回值：'."\n" + .'* **2**：等待用户指定时间。'."\n" + .'* **3**：等待处理。'."\n" + .'* **4**：处理中。进入此状态后，不可调用**ModifyActiveOperationTask**修改计划切换时间。'."\n" + .'* **5**：成功。'."\n" + .'* **6**：失败。'."\n" + .'* **7**：已取消。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Deadline' => [ + 'description' => '运维任务执行时间可调整范围的最晚期时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-03-29T13:59:59Z', + ], + 'PrepareInterval' => [ + 'description' => '运维任务开始时间到切换时间之间所需的准备时间，格式为HH:mm:ss。', + 'type' => 'string', + 'example' => '14:00:00', + ], + 'TaskType' => [ + 'description' => '任务类型，返回值：'."\n" + ."\n" + .'- **rds\\_apsaradb\\_ha**：主备节点切换。'."\n" + .'- **rds\\_apsaradb\\_transfer**：实例迁移。'."\n" + .'- **rds\\_apsaradb\\_upgrade**：小版本升级。'."\n" + .'- **all**：所有任务类型。', + 'type' => 'string', + 'example' => 'rds_apsaradb_upgrade', + ], + 'StartTime' => [ + 'description' => '运维任务执行的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-03-20T02:40:00Z', + ], + 'ModifiedTime' => [ + 'description' => '运维任务修改时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-02-24T08:18:53Z', + ], + 'InsName' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1lgal1sdvxrz****', + ], + 'DbType' => [ + 'description' => '数据库类型，返回值：**redis**。', + 'type' => 'string', + 'example' => 'redis', + ], + 'Region' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hanghzou', + ], + 'CreatedTime' => [ + 'description' => '运维任务的创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-02-24T06:00:11Z', + ], + 'Id' => [ + 'description' => '运维任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1****1', + ], + 'SwitchTime' => [ + 'description' => '系统发起的切换操作的时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2023-03-20T03:10:00Z', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询运维任务详情', + 'description' => '调用本接口查询到当前有运维任务后，您还可以调用[ModifyActiveOperationTask](~~473864~~)修改运维任务的计划切换时间。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeActiveOperationMaintenanceConfig' => [ + 'summary' => '查询实例的运维任务配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HasConfig' => [ + 'description' => '是否已配置：'."\n" + ."\n" + .'- 1：已经配置；'."\n" + .'- 0：未配置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '794120D1-E0CF-4713-BAE4-EBAEA04506AF', + ], + 'Config' => [ + 'description' => '运维任务的配置详情信息。', + 'type' => 'object', + 'properties' => [ + 'CycleType' => [ + 'description' => '周期类型。'."\n" + ."\n" + .'- Month 每月'."\n" + .'- Week 每周', + 'type' => 'string', + 'example' => 'Week', + ], + 'Status' => [ + 'description' => '配置是否生效。'."\n" + ."\n" + .'- 1 生效'."\n" + .'- 2 无效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ModifiedTime' => [ + 'description' => '上一次修改运维任务配置的时间点，格式为yyyy-mm-ddThh:mm:ssZ （utc时间）。', + 'type' => 'string', + 'example' => '2024-05-30T14:30:00Z'."\n", + ], + 'MaintainStartTime' => [ + 'description' => '运维时间窗口开始时间，格式为hh:mm:ssZ (utc时间)。', + 'type' => 'string', + 'example' => '18:00:00Z', + ], + 'MaintainEndTime' => [ + 'description' => '运维时间窗口结束时间，格式为hh:mm:ssZ (utc时间)。', + 'type' => 'string', + 'example' => '20:00:00Z'."\n", + ], + 'CycleTime' => [ + 'description' => '周期时间。'."\n" + ."\n" + .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。配置未生效时为0。'."\n" + .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。配置未生效时为0。', + 'type' => 'string', + 'example' => '1,2,3', + ], + 'CreatedTime' => [ + 'description' => '创建运维任务配置的时间点，格式为yyyy-mm-ddThh:mm:ssZ （utc时间）。', + 'type' => 'string', + 'example' => '2018-05-30T14:30:00Z'."\n", + ], + ], + ], + ], + ], + ], + ], + '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' => '查询实例的运维任务配置', + ], + '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' => '周期类型。'."\n" + ."\n" + .'- Month 每月'."\n" + .'- Week 每周', + 'type' => 'string', + 'required' => false, + 'example' => 'Week', + ], + ], + [ + 'name' => 'CycleTime', + 'in' => 'query', + 'schema' => [ + 'description' => '周期时间。'."\n" + ."\n" + .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。配置未生效时为0。'."\n" + .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。配置未生效时为0。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3,4,5', + ], + ], + [ + 'name' => 'MaintainStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '运维时间窗口开始时间，格式为HH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '16:00:00Z', + ], + ], + [ + 'name' => 'MaintainEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '运维时间窗口结束时间，格式为HH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '20:00:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '是否生效'."\n" + .'- 1：生效'."\n" + .'- 2：不生效', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enum' => [ + '1', + '2', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"561AFBF1-BE20-44DB-9BD1-6988B53E****\\"\\n}","type":"json"}]', + 'title' => '修改运维任务配置', + ], + 'CreateGlobalSecurityIPGroup' => [ + 'summary' => '创建全局IP白名单模板。', + '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' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_123', + 'maxLength' => 120, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GIpList', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单模板内的IP地址。'."\n" + ."\n" + .'> 多个IP地址需要用英文逗号（,）分隔，不可重复，上限为1000个。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.1,10.10.10.10,172.16.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => '全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP白名单模板信息。', + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-sdgwqyp4f5j1x3qk****', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。', + 'type' => 'string', + 'example' => 'test_123', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。', + 'type' => 'string', + 'example' => '192.168.0.1,10.10.10.10,172.16.0.1', + ], + 'RegionId' => [ + 'description' => '地域ID。', + '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' => '创建IP白名单模板', + ], + 'ModifyGlobalSecurityIPGroupName' => [ + 'summary' => '修改全局IP白名单模板的名称。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_123', + 'maxLength' => 120, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板ID，您可以调用[DescribeGlobalSecurityIPGroup](~~2400079~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-kd2iop4aur9qwxnvh***', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '修改IP白名单模板名称', + ], + 'DescribeGlobalSecurityIPGroupRelation' => [ + 'summary' => '查询实例关联的全局IP白名单模板信息。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'r-t4n885e834f6****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBClusterId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-t4n885e834f6****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9B7BFB11-C077-4FE3-B051-F69CEB******', + ], + 'GlobalSecurityIPGroupRel' => [ + 'description' => '关联的全局IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + .'> 多个IP地址需要用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '192.168.0.1,10.10.10.10', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。', + 'type' => 'string', + 'example' => 'test_123', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询实例关联的IP白名单模板信息', + ], + 'DeleteGlobalSecurityIPGroup' => [ + 'summary' => '删除全局IP白名单模板。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + ."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + ."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + ."\n" + .'- 长度为2~120个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_123', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-kd2iop4aur9qwxnvh***', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4e******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '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' => '删除IP白名单模板', + 'description' => '删除IP白名单模板前，您需要先解绑（取消关联）已关联该模板的实例。', + ], + 'ModifyGlobalSecurityIPGroup' => [ + 'summary' => '修改全局IP白名单模板。', + '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' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalIgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求：'."\n" + .'- 由小写字母、数字、下划线（_）组成。'."\n" + .'- 由字母开头、字母或数字结尾。'."\n" + .'- 长度为2~120个字符。'."\n" + .'> 本参数将覆盖原值。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_123', + 'maxLength' => 120, + 'minLength' => 2, + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'GIpList', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板内的IP地址。'."\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', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '修改IP白名单模板', + ], + 'ModifyGlobalSecurityIPGroupRelation' => [ + 'summary' => '将指定实例添加到指定的IP白名单模板中。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'r-t4n885e834f6****', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'IP白名单模板ID。'."\n" + .'> 若您需要取消关联模板，您可以删除对应IP白名单模板ID，本参数会覆盖原值。若您需要取消所有关联模板，您可以传入空字符串。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + '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' => '将实例添加到IP白名单模板中', + ], + 'DescribeGlobalSecurityIPGroup' => [ + 'summary' => '查询全局IP白名单模板列表。', + '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' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalSecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'redis', + 'enum' => [ + 'redis', + 'memcache', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FF6158E-3394-4A90-B634-79C49184****', + ], + 'GlobalSecurityIPGroup' => [ + 'description' => 'IP白名单模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GlobalSecurityGroupId' => [ + 'description' => 'IP白名单模板ID。', + 'type' => 'string', + 'example' => 'g-zsldxfiwjmti0kcm****', + ], + 'GlobalIgName' => [ + 'description' => 'IP白名单模板名称。', + 'type' => 'string', + 'example' => 'test_123', + ], + 'GIpList' => [ + 'description' => '白名单模板内的IP地址。'."\n" + .'> 多个IP地址需要用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '192.168.0.1,10.10.10.10', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DBInstances' => [ + 'description' => '关联该IP白名单模板的实例ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-t4n885e834f6****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询IP白名单模板列表', + ], + 'ModifyInstanceParameter' => [ + 'summary' => '将参数模板应用至指定实例，表示将参数模板的值赋于指定的实例中。当您修改参数模版后，您也需要重新应用至指定实例，才能将修改后的参数值赋于指定实例。', + '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' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模板ID。'."\n" + .'> 您可以通过DescribeParameterGroups接口查看目标地域的参数模板列表，包括参数模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'g-idhwofwofewhf****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'description' => '参数信息。', + '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。', + 'type' => 'string', + 'example' => '561AFBF1-BE20-44DB-9BD1-6988B53E****', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + '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' => '应用参数模板到实例', + ], + 'DeleteParameterGroup' => [ + 'summary' => '删除参数模板。', + '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' => '参数模版ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'g-sysa00*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', + ], + 'ParamGroupId' => [ + 'description' => '参数模板ID。', + 'type' => 'string', + 'example' => 'rpg-sys-00*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BE6E619-A657-42E3-AD2D-18F8428A****\\",\\n \\"ParamGroupId\\": \\"rpg-sys-00*****\\"\\n}","type":"json"}]', + 'title' => '删除参数模板', + ], + 'DescribeParameterGroupSupportParam' => [ + 'summary' => '查询在不同版本的参数模版中支持设置的参数列表。', + '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' => '产品类别，取值：'."\n" + .'* **standard**：Redis开源版。'."\n" + .'* **enterprise**：Tair（Redis 企业版）。', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '兼容版本，取值：'."\n" + .'* Redis开源版支持**5.0**、**6.0**和**7.0**。'."\n" + .'* Tair内存型兼容 Redis 5.0 和 Redis 6.0 协议，传**5.0**、**6.0**。'."\n" + .'* Tair持久内存型兼容Redis 6.0协议，传**1.0**。'."\n" + .'* Tair 磁盘（ESSD/SSD）兼容 Redis 6.0 协议。 创建ESSD型的参数模板请传入**1.0**、创建SSD型的参数模板请传入**2.0**。', + 'type' => 'string', + 'required' => true, + 'example' => '5.0', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => '引擎类型，取值：'."\n" + .'* **redis**：Redis开源版或Tair内存型。'."\n" + .'* **tair_pena**：Tair持久内存型。'."\n" + .'* **tair_pdb**：Tair磁盘型（ESSD/SSD）。', + 'type' => 'string', + 'required' => false, + 'example' => 'redis', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BB73740C-23E2-4392-9DA4-2660C74C****', + ], + 'ResourceList' => [ + 'description' => '参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '参数列表。', + 'type' => 'object', + 'properties' => [ + 'DbType' => [ + 'description' => '引擎类型。', + 'type' => 'string', + 'example' => 'redis', + ], + 'DbVersion' => [ + 'description' => '引擎兼容版本。', + 'type' => 'string', + 'example' => '5.0', + ], + 'Category' => [ + 'description' => '产品类别。', + 'type' => 'string', + 'example' => 'standard', + ], + 'ParamName' => [ + 'description' => '支持设置的参数。', + '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' => '参数模版支持设置的参数列表', + ], + 'DescribeParameterGroup' => [ + 'summary' => '查询参数模版基本信息。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模版ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rpg-sys-00*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A501A191-BD70-5E50-98A9-C2A486A82****', + ], + 'ParameterGroup' => [ + 'description' => '返回参数模板对象。', + 'type' => 'object', + 'properties' => [ + 'EngineVersion' => [ + 'description' => '引擎兼容版本。', + 'type' => 'string', + 'example' => '5.0', + ], + 'Modified' => [ + 'description' => '参数模板的最近修改时间。', + 'type' => 'string', + 'example' => '2023-04-18 16:32:45', + ], + 'ParameterGroupName' => [ + 'description' => '参数模板名称。', + 'type' => 'string', + 'example' => 'testGroupName', + ], + 'ParameterGroupDesc' => [ + 'description' => '参数模版的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'Engine' => [ + 'description' => '参数模本引擎', + 'type' => 'string', + 'example' => 'redis', + ], + 'ParamGroupId' => [ + 'description' => '参数模板ID，全局唯一。', + 'type' => 'string', + 'example' => 'sys-001*****', + ], + 'Created' => [ + 'description' => '参数模板的创建时间。', + 'type' => 'string', + 'example' => '2023-04-18 16:32:45', + ], + 'Category' => [ + 'description' => '产品类别，取值：'."\n" + .'- **0**：Redis开源版'."\n" + .'- **1**：Tair（企业版）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ParamGroupsDetails' => [ + 'description' => '参数模板的参数详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParamName' => [ + 'description' => '参数名称。', + 'type' => 'string', + 'example' => 'timeout', + ], + 'ParamValue' => [ + 'description' => '参数值。', + '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' => '查询参数模版基本信息', + ], + 'ModifyParameterGroup' => [ + 'summary' => '修改参数模板的设置。', + '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' => '实例所属地域的ID，您可以调用[DescribeInstanceAttribute](~~473779~~)接口查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-zhangjiakou', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类别，取值：'."\n" + .'- **standard**：Redis开源版'."\n" + .'- **enterprise**：Tair（企业版）', + 'type' => 'string', + 'required' => true, + 'example' => 'enterprise', + ], + ], + [ + 'name' => 'ParameterGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模版ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'sys-001****', + ], + ], + [ + 'name' => 'ParameterGroupDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模板的描述。长度为0~200个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ParameterGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '修改参数模板的名称，需满足如下要求：'."\n" + .'* 由英文、数字、和下划线（_）组成，以字母开头，不能包含中文。'."\n" + .'* 长度为8~64个字符。'."\n" + .'> 该参数必填，如不希望变更参数模板名称，请传入原参数模板名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testGroupName', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'description' => '参数和对应值的JSON格式文本，格式：{"参数1":"参数1值","参数2":"参数2值",...}，传入的值将覆盖原内容。'."\n" + .'> 不同版本可添加的参数以控制台为准。', + 'type' => 'string', + 'required' => true, + 'example' => '{"hz":"12"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AD425AD3-CC7B-4EE2-A5CB-2F61BA73****', + ], + 'ParamGroupId' => [ + 'description' => '参数模板ID。', + 'type' => 'string', + 'example' => 'testGroupName', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD425AD3-CC7B-4EE2-A5CB-2F61BA73****\\",\\n \\"ParamGroupId\\": \\"testGroupName\\"\\n}","type":"json"}]', + 'title' => '修改参数模版', + ], + 'DescribeParameterGroups' => [ + 'summary' => '查询可用的参数模版列表。', + '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' => '地域ID，您可以调用[DescribeRegions](~~473763~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DbType', + 'in' => 'query', + 'schema' => [ + 'description' => '引擎类型，取值：'."\n" + .'- **redis**：Redis开源版或Tair内存型。'."\n" + .'- **tair_pena**：Tair持久内存型。'."\n" + .'- **tair_pdb**：Tair磁盘型（ESSD/SSD）。', + 'type' => 'string', + 'required' => false, + 'example' => 'redis', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '686BB8A6-BBA5-47E5-8A75-D2ADE433****', + ], + 'ParameterGroups' => [ + 'description' => '参数模版列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EngineVersion' => [ + 'description' => '引擎兼容版本。', + 'type' => 'string', + 'example' => '5', + ], + 'Modified' => [ + 'description' => '参数模板的最近修改时间。', + 'type' => 'string', + 'example' => '2023-04-18 16:32:45', + ], + 'ParameterGroupName' => [ + 'description' => '参数模版名称。', + 'type' => 'string', + 'example' => 'testGroupName', + ], + 'ParameterGroupDesc' => [ + 'description' => '参数模版的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'Engine' => [ + 'description' => '引擎类型，取值如下：'."\n" + .'- **redis**：Redis开源版或Tair内存型。'."\n" + .'- **tair_pena**：Tair持久内存型。'."\n" + .'- **tair_pdb**：Tair磁盘型。', + 'type' => 'string', + 'example' => 'tair_pena', + ], + 'ParamGroupId' => [ + 'description' => '参数模板ID。', + 'type' => 'string', + 'example' => 'test01', + ], + 'Created' => [ + 'description' => '参数模版的创建时间。', + 'type' => 'string', + 'example' => '2023-04-18 16:32:45'."\n", + ], + 'Category' => [ + 'description' => '产品类别，取值：'."\n" + .'- **0**：Redis开源版'."\n" + .'- **1**：Tair（企业版）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询参数模版列表', + ], + 'CreateParameterGroup' => [ + 'summary' => '创建参数模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '产品类别，取值：'."\n" + .'* **standard**：Redis开源版。'."\n" + .'* **enterprise**：Tair（企业版）。', + 'type' => 'string', + 'required' => true, + 'example' => 'enterprise', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => '引擎类型，取值：'."\n" + .'* **redis**：Redis开源版或Tair内存型。'."\n" + .'* **tair_pena**：Tair持久内存型。'."\n" + .'* **tair_pdb**：Tair磁盘型（ESSD/SSD）。', + 'type' => 'string', + 'required' => true, + 'example' => 'redis', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '兼容版本，取值：'."\n" + .'* Redis开源版支持**5.0**、**6.0**和**7.0**。'."\n" + .'* Tair内存型兼容 Redis 5.0、6.0和7.0协议，传**5.0**、**6.0**或**7.0**。'."\n" + .'* Tair持久内存型兼容Redis 6.0协议，传**1.0**。'."\n" + .'* Tair 磁盘（ESSD/SSD）兼容 Redis 6.0 协议。 创建ESSD型的参数模板请传入**1.0**、创建SSD型的参数模板请传入**2.0**。', + 'type' => 'string', + 'required' => true, + 'example' => '6.0', + ], + ], + [ + 'name' => 'ParameterGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模板的名称，需满足如下要求：'."\n" + .'- 由英文、数字、和下划线（_）组成，以字母开头，不能包含中文。'."\n" + .'- 长度为8~64个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'tw_test1', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'description' => '参数和对应值的JSON格式文本，格式：{"参数1":"参数1值","参数2":"参数2值"......}。'."\n" + .'> 不同版本可添加的参数以控制台为准。', + 'type' => 'string', + 'required' => true, + 'example' => '{"hz":"15","#no_loose_disabled-commands":"flushall"}', + ], + ], + [ + 'name' => 'ParameterGroupDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '参数模板的描述。长度为0~200个字符。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '62DA5BE5-F9C9-527C-ACCB-4D783C297A3A', + ], + 'ParamGroupId' => [ + 'description' => '参数模板ID。', + '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' => '创建参数模板', + 'description' => '参数模板仅适用于云原生部署模式实例（原云盘实例）。', + ], + 'DescribeParameterGroupTemplateList' => [ + 'summary' => '查询参数模板中可配置参数的具体信息，例如默认值、取值范围、描述等。', + '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' => '产品类别，取值：'."\n" + .'- **standard**：Redis开源版'."\n" + .'- **enterprise**：Tair（企业版）', + 'type' => 'string', + 'required' => true, + 'example' => 'standard', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '兼容版本，取值：'."\n" + .'* Redis开源版支持**5.0**、**6.0**和**7.0**。'."\n" + .'* Tair内存型兼容 Redis 5.0、6.0和7.0协议，传**5.0**、**6.0**或**7.0**。'."\n" + .'* Tair持久内存型兼容Redis 6.0协议，传**1.0**。'."\n" + .'* Tair 磁盘（ESSD/SSD）兼容 Redis 6.0 协议。 创建ESSD型的参数模板请传入**1.0**、创建SSD型的参数模板请传入**2.0**。', + 'type' => 'string', + 'required' => true, + 'example' => '5.0', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'schema' => [ + 'description' => '引擎类型，取值：'."\n" + .'- **redis**：Redis开源版或Tair内存型'."\n" + .'- **tair_pena**：Tair持久内存型'."\n" + .'- **tair_pdb**：Tair 磁盘型（ESSD/SSD）', + 'type' => 'string', + 'required' => true, + 'example' => 'redis', + ], + ], + [ + 'name' => 'CharacterType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的角色类型，取值说明：'."\n" + .'* **logic**：集群逻辑实例'."\n" + .'* **db**：集群DB实例'."\n" + .'* **proxy**：集群Proxy实例'."\n" + .'* **cs**：集群CS实例'."\n" + .'* **normal**：主备DB实例', + 'type' => 'string', + 'required' => false, + 'example' => 'db', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5D622714-AEDD-4609-9167-F5DDD3D1****', + ], + 'EngineVersion' => [ + 'description' => '兼容版本。', + 'type' => 'string', + 'example' => '5', + ], + 'Parameters' => [ + 'description' => '参数的详细信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '参数信息。', + 'type' => 'object', + 'properties' => [ + 'SupportModifyForMinorVersion' => [ + 'description' => '是否支持修改小版本：'."\n" + .'* **true**：支持'."\n" + .'* **false**：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CheckingCode' => [ + 'description' => '参数取值范围。', + 'type' => 'string', + 'example' => '[0|1]', + ], + 'ParameterValue' => [ + 'description' => '参数默认值。', + 'type' => 'string', + 'example' => '10', + ], + 'Revisable' => [ + 'description' => '是否可以修改'."\n" + ."\n" + .'- **0**：不能修改。'."\n" + .'- **1**：修改。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Factor' => [ + 'description' => '整除因子。对于整数和字节类型的参数，参数值除了必须满足参数的可选范围，还须是Factor（不等于0）的倍数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ParameterName' => [ + 'description' => '参数名称。', + 'type' => 'string', + 'example' => 'appendonly', + ], + 'Unit' => [ + 'description' => '参数值单位。'."\n" + .'* **INT**：普通的整型。'."\n" + .'* **STRING**：固定的字符串。'."\n" + .'* **B**：字节。', + 'type' => 'string', + 'example' => 'STRING', + ], + 'ParameterDescription' => [ + 'description' => '参数描述。', + 'type' => 'string', + 'example' => '开启Aof持久化模式。', + ], + 'Effective' => [ + 'description' => '是否生效：'."\n" + .'* **0**：否'."\n" + .'* **1**：是', + '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' => '参数模版系统参数', + ], + 'DescribeActiveOperationTasks' => [ + 'summary' => '查询实例的运维事件详情。', + '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' => '待处理事件所属的地域ID，可调用[DescribeRegions](~~473763~~)接口获取。'."\n" + .'> 取值为**all**表示所有地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '运维事件类型，如果为空则查询所有类型。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [ + 'rds_apsradb_upgrade' => '小版本升级', + 'rds_apsaradb_ha' => '主备切换', + 'rds_apsaradb_ssl_update' => 'SSL证书更新', + 'rds_apsaradb_major_upgrade' => '大版本升级', + 'rds_apsradb_transfer' => '实例迁移', + 'rds_apsaradb_network_upgrade' => '网络升级', + 'rds_apsaradb_modify_config' => '实例参数调整', + 'rds_apsaradb_maxscale' => '代理小版本升级', + ], + 'example' => 'rds_apsradb_transfer', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，默认为25，最大 100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '25', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于 0, 默认 1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ProductId', + 'in' => 'query', + 'schema' => [ + 'description' => '产品名称, RDS/POLARDB/MongoDB/Redis，对于 Redis 实例可选 Redis。', + 'type' => 'string', + 'required' => false, + 'example' => 'Redis', + ], + ], + [ + 'name' => 'DbType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型：**redis**。', + 'type' => 'string', + 'required' => false, + 'example' => 'redis', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '运维事件状态，用于筛选返回任务，取值：'."\n" + .'* **-1**：全部事件。'."\n" + .'* **3**：待处理事件。'."\n" + .'* **4**：处理中事件。'."\n" + .'* **5**：成功结束事件。'."\n" + .'* **6**：失败结束事件。'."\n" + .'* **7**：已取消事件。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'InsName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名，可不填，填写时只允许填写至多一个实例名。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-wz96fzmpvpr2qnqnlb', + ], + ], + [ + 'name' => 'AllowChange', + 'in' => 'query', + 'schema' => [ + 'description' => '是否允许修改时间，默认-1，取值：'."\n" + ."\n" + .'- **-1**：全部。'."\n" + .'- **0**：只返回不允许修改时间的运维事件。'."\n" + .'- **1**：只返回允许修改时间的运维事件。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'AllowCancel', + 'in' => 'query', + 'schema' => [ + 'description' => '是否允许取消，默认-1，取值：'."\n" + ."\n" + .'- **-1**：全部。'."\n" + .'- **0**：只返回不允许取消的运维事件。'."\n" + .'- **1**：只返回允许取消的运维事件。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ChangeLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '变更级别，默认all：'."\n" + ."\n" + .'- **all**：选择全部异常修复和系统运维的级别'."\n" + .'- **S0**：异常修复'."\n" + .'- **S1**：系统运维', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D9F3768-EDA9-4811-943E-42C8006E****', + ], + 'PageSize' => [ + 'description' => '分页大小，默认为25。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'TotalRecordCount' => [ + 'description' => '返回运维事件记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Items' => [ + 'description' => '运维事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '运维事件详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '运维事件状态，返回值：'."\n" + .'- **3**：待处理事件。'."\n" + .'- **4**：处理中事件。'."\n" + .'- **5**：成功结束事件。'."\n" + .'- **6**：失败结束事件。'."\n" + .'- **7**：已取消事件。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ChangeLevelEn' => [ + 'description' => '事件等级（英文）。', + 'type' => 'string', + 'example' => 'System maintenance'."\n", + ], + 'TaskType' => [ + 'description' => '运维事件务类型。', + 'type' => 'string', + 'example' => 'rds_apsaradb_transfer', + ], + 'InsName' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp1lgal1sdvxrz****', + ], + 'Region' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hanghzou', + ], + 'ImpactZh' => [ + 'description' => '事件影响（中文）。', + 'type' => 'string', + 'example' => '实例闪断'."\n", + ], + 'CreatedTime' => [ + 'description' => '创建时间，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2018-05-30T14:30:00Z'."\n", + ], + 'SwitchTime' => [ + 'description' => '后台发起切换操作的时间点，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2018-05-30T14:30:00Z'."\n", + ], + 'ChangeLevelZh' => [ + 'description' => '事件等级（中文）。', + 'type' => 'string', + 'example' => '系统运维'."\n", + ], + 'Deadline' => [ + 'description' => '任务执行时间可调整范围的最晚期限，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2018-05-30T23:59:59Z', + ], + 'PrepareInterval' => [ + 'description' => '开始时间到切换时间之间所需的准备时间, 格式为 HH:mm:ss。', + 'type' => 'string', + 'example' => '04:00:00'."\n", + ], + 'TaskTypeZh' => [ + 'description' => '任务原因中文。', + 'type' => 'string', + 'example' => '小版本升级'."\n", + ], + 'CurrentAVZ' => [ + 'description' => '当前可用区。', + 'type' => 'string', + 'example' => 'cn-beijing-h'."\n", + ], + 'AllowChange' => [ + 'description' => '是否允许修改时间，1 表示允许用户修改时间，0 表示不允许用户修改时间。', + 'type' => 'string', + 'example' => '1', + ], + 'DbVersion' => [ + 'description' => '内核版本号。', + 'type' => 'string', + 'example' => '5.0', + ], + 'ImpactEn' => [ + 'description' => '事件影响（英文）。', + 'type' => 'string', + 'example' => 'Transient instance disconnection', + ], + 'InsComment' => [ + 'description' => '实例别名/实例备注。', + 'type' => 'string', + 'example' => 'test', + ], + 'StartTime' => [ + 'description' => '后台执行事件的时间点，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2018-05-30T00:00:00Z'."\n", + ], + 'ModifiedTime' => [ + 'description' => '修改时间，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2018-05-30T14:30:00Z'."\n", + ], + 'AllowCancel' => [ + 'description' => '是否允许取消，1 表示允许用户取消事件，0 表示不允许取消。', + 'type' => 'string', + 'example' => '1', + ], + 'DbType' => [ + 'description' => '数据库类型，返回值：**redis**。', + 'type' => 'string', + 'example' => 'redis', + ], + 'ChangeLevel' => [ + 'description' => '事件等级代码，S1 系统运维 S0 风险修复。', + 'type' => 'string', + 'example' => 'S1', + ], + 'TaskTypeEn' => [ + 'description' => '产生运维事件原因英文。', + 'type' => 'string', + 'example' => 'Minor version update', + ], + 'ResultInfo' => [ + 'description' => '执行结果信息。', + 'type' => 'string', + 'example' => 'userCancel', + ], + 'Id' => [ + 'description' => '运维事件 ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11111', + ], + 'SubInsNames' => [ + 'description' => '子事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子事件名称。', + 'type' => 'string', + 'example' => 'sub1369716295573-tes2cy6****.2013052818****'."\n", + ], + ], + 'TaskParams' => [ + 'description' => '运维事件参数。', + 'type' => 'string', + 'example' => '{'."\n" + .' "Action": "UpgradeDBInstance"'."\n" + .'}', + ], + 'Impact' => [ + 'description' => '事件影响。', + 'type' => 'string', + 'example' => 'TransientDisconnection', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询多个主动运维事件信息', + ], + 'ModifyActiveOperationTasks' => [ + 'summary' => '修改实例计划内运维事件的切换时间。', + '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' => '运维事件 ID，多个 ID 间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1111721,1111718', + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'description' => '要设置的计划切换时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。'."\n" + ."\n" + .'> '."\n" + .'> 不能晚于最晚操作时间。'."\n" + .'您可以调用 DescribeActiveOperationTasks，通过返回参数 Deadline 的值来获取最晚操作时间。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-10-17T18:50:00Z'."\n", + ], + ], + [ + 'name' => 'ImmediateStart', + 'in' => 'query', + 'schema' => [ + 'description' => '是否立即进入执行调度。'."\n" + ."\n" + .'- 0：否（默认）'."\n" + .'- 1：是'."\n" + ."\n" + .'> '."\n" + .'> 值为 0 时 switchTime 生效；值为 1 时 switchTime 不生效，事件开始时间将设置为当前时间，切换时间根据新的开始时间自动计算。'."\n" + .'事件立即进入执行调度（并非立即切换），进行切换的前置准备，准备完成后，进行切换。您可以调用 DescribeActiveOperationTasks，通过返回参数 PrepareInterval 的值来获取准备时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => '运维事件 ID，多个 ID 间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '11111,22222', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E278D833-BB4B-50BF-8646-7BC1BAB2373B', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"11111,22222\\",\\n \\"RequestId\\": \\"E278D833-BB4B-50BF-8646-7BC1BAB2373B\\"\\n}","type":"json"}]', + 'title' => '修改运维事件的计划切换时间', + ], + 'CancelActiveOperationTasks' => [ + 'summary' => '批量取消运维事件。', + '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' => '批量取消的运维任事件ID，多个 ID 间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1508850,1508310,1507849,1506274,1505811', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Ids' => [ + 'description' => '批量取消的运维事件 ID，多个 ID 间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '1508850,1508310,1507849,1506274', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F16A51B0-436E-5B84-8326-A18AA150D1C4', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"1508850,1508310,1507849,1506274\\",\\n \\"RequestId\\": \\"F16A51B0-436E-5B84-8326-A18AA150D1C4\\"\\n}","type":"json"}]', + 'title' => '取消运维事件', + 'description' => '运维事件不允许取消的场景'."\n" + ."\n" + .'- allowCancel为0'."\n" + .'- 当前时间大于运维事件开始时间'."\n" + .'- 运维事件状态值不为3（等待执行）', + ], + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'title' => '事件ID，多个英文逗号分隔，最多支持20个', + 'description' => '事件ID。如需查询多个，使用英文逗号分隔，最多支持20个。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5422964'."\n", + ], + ], + [ + 'name' => 'EventAction', + 'in' => 'query', + 'schema' => [ + 'title' => '事件处理动作，目前支持archive和undo', + 'description' => '事件处理动作，取值说明：'."\n" + .'- **archive**：归档'."\n" + .'- **undo**：不处理', + 'type' => 'string', + 'required' => false, + 'example' => 'archive', + ], + ], + [ + 'name' => 'ActionParams', + 'in' => 'query', + 'schema' => [ + 'title' => '动作参数，JSON String', + 'description' => '动作相关的参数，Json格式。'."\n" + .'当**TaskAction**取值**modifySwitchTime**时，本参数ActionParams取值为 `{"recoverMode": "xxx", "recoverTime": "xxx"}`。'."\n" + .'* **recoverMode**表示任务恢复模式，取值为：'."\n" + .' * **imePoint**：按照指定时间点执行。'."\n" + .' * **immediate**: 立即执行。'."\n" + .' * **maintainTime**：按照运维时间执行。'."\n" + ."\n" + .'* **recoverTime**表示指定的时间点，UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ，当**recoverMode**为**timePoint**时，该参数必填。', + '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', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6C9E114C-217C-4118-83C0-B4070222****', + ], + 'ErrorEventId' => [ + 'description' => '错误id。', + 'type' => 'string', + 'example' => '12343', + ], + 'SuccessCount' => [ + 'description' => '成功记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'mst.errorcode.success.errormessage', + ], + 'SuccessEventId' => [ + 'description' => '成功事件id。', + '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' => '修改事件信息', + ], + 'DescribeHistoryEvents' => [ + 'summary' => '查询事件中心中的历史事件', + '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' => '实例所属的地域ID，可调用[DescribeRegions](~~473763~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的记录数，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，取值大于 0 且不超过 integer 的最大值，默认值为 1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ArchiveStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '事件状态。取值说明：'."\n" + .'- **Archived**：已归档'."\n" + .'- **UnArchived**：未归档'."\n" + .'- **All**：所有', + 'type' => 'string', + 'required' => false, + 'example' => 'Archived', + ], + ], + [ + 'name' => 'EventCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '系统事件分类。取值说明：'."\n" + .'- **Exception**：异常事件'."\n" + .'- **Optimize**：优化事件'."\n" + .'- **Notification**：通知事件'."\n" + .'- **Maintenance**：计划内运维事件', + 'type' => 'string', + 'required' => false, + 'example' => 'Exception', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '系统事件的类型。EventType参数只在未指定InstanceEventType.N参数时有效。取值范围： '."\n" + ."\n" + .'- SystemMaintenance.Reboot：因系统维护实例重启。'."\n" + .'- SystemMaintenance.Redeploy：因系统维护实例重新部署。'."\n" + .'- SystemFailure.Reboot：因系统错误实例重启。'."\n" + .'- SystemFailure.Redeploy：因系统错误实例重新部署。'."\n" + .'- SystemFailure.Delete：因实例创建失败实例释放。'."\n" + .'- InstanceFailure.Reboot：因实例错误实例重启。'."\n" + .'- InstanceExpiration.Stop：因包年包月期限到期，实例停止。'."\n" + .'- InstanceExpiration.Delete：因包年包月期限到期，实例释放。'."\n" + .'- AccountUnbalanced.Stop：因账号欠费，按量付费实例停止。'."\n" + .'- AccountUnbalanced.Delete：因账号欠费，按量付费实例释放。'."\n" + ."\n" + .'> 事件类型说明请参见[系统事件概述](~~66574~~)。该参数的取值只能是实例系统事件，不能是磁盘系统事件。', + 'type' => 'string', + 'required' => false, + 'example' => 'SystemFailure.Reboot'."\n", + ], + ], + [ + 'name' => 'EventLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '事件级别，取值说明：'."\n" + .'- **INFO**：通知'."\n" + .'- **WARN**：警告'."\n" + .'- **CRITICAL**：紧急', + 'type' => 'string', + 'required' => false, + 'example' => 'INFO', + ], + ], + [ + 'name' => 'EventStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '事件状态，取值说明：'."\n" + .'- **Inquiring**：问询中'."\n" + .'- **Scheduled**：计划中'."\n" + .'- **Running**：执行中'."\n" + .'- **Succeed**：执行完成'."\n" + .'- **Failed**：执行失败'."\n" + .'- **Canceled**：已取消'."\n" + .'> 如需查询多个状态，使用英文逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'Scheduled', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值说明：'."\n" + .'- **Instance**：实例资源'."\n" + .'- **Host**：主机资源'."\n" + .'- **User**：用户资源'."\n" + .'> 该参数不填写，表示查询所有类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'Instance', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5345398', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '578678678', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询任务的最早开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询任务的最晚开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间），需晚于任务的最早开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-02-02T11:31:03Z', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfnuslkubs****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '27B911BF-4E17-5F8A-A932-79DF2D3F****', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '430', + ], + 'Items' => [ + 'description' => '事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '4309', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hanghzou', + ], + 'Source' => [ + 'description' => '事件来源。', + 'type' => 'string', + 'example' => 'loanBill', + ], + 'Specversion' => [ + 'description' => '数据库版本。', + 'type' => 'string', + 'example' => '8.0', + ], + 'Subject' => [ + 'description' => '待处理事件的名称。', + 'type' => 'string', + 'example' => 'Qitian', + ], + 'Time' => [ + 'description' => '查询任务已运行时间。单位：秒。', + 'type' => 'string', + 'example' => '1734919325126', + ], + 'Type' => [ + 'description' => '事件类型。', + 'type' => 'string', + 'example' => 'host', + ], + 'Data' => [ + 'description' => '数据概览。', + 'type' => 'object', + 'properties' => [ + 'EventType' => [ + 'description' => '系统事件类型，取值说明： '."\n" + .'- **SystemMaintenance.Reboot**：因系统维护实例重启'."\n" + .'- **SystemMaintenance.Redeploy**：因系统维护实例重新部署'."\n" + .'- **SystemFailure.Reboot**：因系统错误实例重启'."\n" + .'- **SystemFailure.Redeploy**：因系统错误实例重新部署'."\n" + .'- **SystemFailure.Delete**：因实例创建失败实例释放'."\n" + .'- **InstanceFailure.Reboot**：因实例错误实例重启'."\n" + .'- **InstanceExpiration.Stop**：因包年包月期限到期，实例停止'."\n" + .'- **InstanceExpiration.Delete**：因包年包月期限到期，实例释放'."\n" + .'- **AccountUnbalanced.Stop**：因账号欠费，按量付费实例停止'."\n" + .'- **AccountUnbalanced.Delete**：因账号欠费，按量付费实例释放', + 'type' => 'string', + 'example' => 'StatusNotification', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '669036', + ], + 'CmsProduct' => [ + 'description' => '应用分组的云服务类型，取值说明：'."\n" + .'- **web**：web应用。'."\n" + .'- **native**：本地应用。', + 'type' => 'string', + 'example' => 'web', + ], + 'DbType' => [ + 'description' => '数据库类型', + 'type' => 'string', + 'example' => 'redis', + ], + 'DetailImpact' => [ + 'description' => '翻页参数。', + 'type' => 'string', + 'example' => '1', + ], + 'DetailReason' => [ + 'description' => '实例操作详情。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'EndTime' => [ + 'description' => '告警结束时间。', + 'type' => 'string', + 'example' => '2023-03-06T11:46:01Z'."\n", + ], + 'EventCategory' => [ + 'description' => '系统事件分类。取值说明：'."\n" + .'- **Exception**：异常事件'."\n" + .'- **Optimize**：优化事件'."\n" + .'- **Notification**：通知事件'."\n" + .'- **Maintenance**：计划内运维事件', + 'type' => 'string', + 'example' => 'Exception', + ], + 'EventCode' => [ + 'description' => '事件编码。', + 'type' => 'string', + 'example' => 'ENT000014'."\n", + ], + 'EventDetail' => [ + 'description' => '事件详情。', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'EventImpact' => [ + 'description' => '事件影响概况。', + 'type' => 'string', + 'example' => 'xxxxx'."\n", + ], + 'EventLevel' => [ + 'description' => '事件级别，取值说明：'."\n" + .'- **INFO**：通知'."\n" + .'- **WARN**：警告'."\n" + .'- **CRITICAL**：紧急', + 'type' => 'string', + 'example' => 'INFO', + ], + 'EventReason' => [ + 'description' => '事件操作的来源。', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'EventStatus' => [ + 'description' => '事件状态，取值说明：'."\n" + .'- **Inquiring**：问询中'."\n" + .'- **Scheduled**：计划中'."\n" + .'- **Running**：执行中'."\n" + .'- **Succeed**：执行完成'."\n" + .'- **Failed**：执行失败'."\n" + .'- **Canceled**：已取消', + 'type' => 'string', + 'example' => 'Succeed', + ], + 'GmtCreated' => [ + 'description' => '事件的创建时间。', + 'type' => 'string', + 'example' => '2024-12-13 05:34:23', + ], + 'GmtModified' => [ + 'description' => '事件的更新时间。', + 'type' => 'string', + 'example' => '2025-03-05 10:41:59', + ], + 'HandleStatus' => [ + 'description' => '处理状态。', + 'type' => 'string', + 'example' => 'done', + ], + 'HasLifeCycle' => [ + 'description' => '是否有生命周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'false', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'r-bp15kjsoovqjam****', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'normandy', + ], + 'IsClosed' => [ + 'description' => '是否关闭成功，取值说明：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Product' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => 'kvstore', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResourceType' => [ + 'description' => '资源类型，取值说明：'."\n" + .'- **Instance**：实例资源'."\n" + .'- **Host**：主机资源'."\n" + .'- **User**：用户资源', + 'type' => 'string', + 'example' => 'Instance', + ], + 'SourceType' => [ + 'description' => '源数据的类型。', + 'type' => 'string', + 'example' => 'MSE', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2025-09-30T21:13Z', + ], + 'Uid' => [ + 'description' => '资源所属的用户ID。', + 'type' => 'string', + 'example' => '15532817595*****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询历史事件', + ], + 'DescribeHistoryEventsStat' => [ + 'summary' => '查询历史事件统计。', + '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' => '地域ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ArchiveStatus', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '事件状态。取值说明：'."\n" + .'- **Archived**：已归档'."\n" + .'- **UnArchived**：未归档'."\n" + .'- **All**：所有', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Archived', + ], + ], + [ + 'name' => 'FromStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间的起始时间，表示查询任务开始时间在此时间之后的任务。按照 ISO8601 标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。最早支持 30 天前，距当前时间超过 30 天会自动转换成 30 天前。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-01-02T11:31:03Z', + ], + ], + [ + 'name' => 'ToStartTime', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '任务开始时间的结束时间，表示查询任务开始时间在此时间之前的任务。按照 ISO8601 标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2022-02-02T11:31:03Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B32A350C-3A8E-5FF1-A56F-51C3769D****', + ], + 'Items' => [ + 'description' => '事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件列表。', + 'type' => 'object', + 'properties' => [ + 'EventCategory' => [ + 'description' => '系统事件分类。取值说明：'."\n" + .'- **Exception**：异常事件'."\n" + .'- **Optimize**：优化事件'."\n" + .'- **Notification**：通知事件'."\n" + .'- **Maintenance**：计划内运维事件', + 'type' => 'string', + 'example' => 'Exception', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + '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' => '查询历史事件统计', + ], + 'SwitchInstanceZoneFailOver' => [ + 'summary' => '模拟云数据库 Tair（兼容 Redis）集群架构实例发生可用区级别故障，实例将自动切换到备可用区中。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'TargetZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-j', + ], + ], + [ + 'name' => 'SiteFaultTime', + 'in' => 'query', + 'schema' => [ + 'description' => '故障持续时间，单位：分钟。'."\n" + .'支持选择以下时间：'."\n" + .'- 5'."\n" + .'- 10'."\n" + .'- 30', + 'type' => 'string', + 'required' => false, + 'example' => '5', + 'default' => '5', + 'enum' => [ + '5', + '10', + '30', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '操作响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID 。', + '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' => '模拟可用区级别故障切换', + 'description' => '- 本接口仅适用于多（双）可用区集群架构实例。'."\n" + .'- 模拟故障的节点会在稍后自动恢复。但主节点位于备可用区、备节点位于主可用区，此时可能产生实例与其他业务跨机房访问的情况。如需解决该问题，您可以在控制台服务可用性页面手动切换可用区。', + ], + 'MasterNodeShutDownFailOver' => [ + 'summary' => '模拟云数据库 Tair（兼容 Redis）的指定数据节点或Proxy节点故障，实例将自动进行主备切换，保证高可用。', + '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**：模拟硬件的不可恢复故障，此时将直接触发切换（HA）。'."\n" + .'- **Soft**（默认）：模拟硬件的可恢复故障，此时将优先尝试恢复故障节点，若失败则触发切换（HA）。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'UnSafe' => '已废弃', + 'Hard' => 'Hard', + 'Safe' => '已废弃', + 'Soft' => 'Soft', + ], + 'example' => 'Hard', + 'default' => 'Safe', + 'enum' => [ + 'Safe', + 'UnSafe', + 'Hard', + 'Soft', + ], + ], + ], + [ + 'name' => 'DBNodes', + 'in' => 'query', + 'schema' => [ + 'description' => '指定的数据节点。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'r-rdsdavinx01003-db-0,r-rdsdavinx01003-db-1', + ], + ], + [ + 'name' => 'ProxyInstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '指定的Proxy节点。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '6981,6982', + ], + ], + [ + 'name' => 'ProxyFaultMode', + 'in' => 'query', + 'schema' => [ + 'description' => '- **Specify**: 指定Proxy节点。'."\n" + .'- **Random**: 表示系统随机模拟1/4个Proxy节点故障（不足1时取1、大于时向上取整），该参数仅在没有指定Proxy节点时生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'Specify', + 'enum' => [ + 'Specify', + 'Random', + ], + ], + ], + [ + 'name' => 'DBFaultMode', + 'in' => 'query', + 'schema' => [ + 'description' => '- **Specify**：指定数据节点。'."\n" + .'- **Random**：表示系统随机模拟1/4个数据节点故障（不足1时取1、大于时向上取整），该参数仅在没有指定数据节点时生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'Random', + 'enum' => [ + 'Specify', + 'Random', + ], + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '产品资源类别，取值固定值`instance`。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + 'default' => 'instance', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '模拟操作响应', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '12123216-4B00-4378-BE4B-08005BFC****', + ], + 'DBInstanceId' => [ + 'description' => '实例ID 。', + 'type' => 'string', + 'example' => 'r-bp1zxszhcgatnx****', + ], + 'TaskID' => [ + 'description' => '任务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' => '模拟指定节点故障', + 'description' => '- 调用本接口时，指定的节点会关闭。实例会自动触发主备切换，将备节点提升为主节点。'."\n" + .'- 模拟故障的节点会在稍后自动恢复。'."\n" + .'- 单节点（单副本）不支持调用本接口。', + ], + 'ModifyInstanceBandwidth' => [ + 'summary' => '设置云数据库 Tair（兼容 Redis）实例的目标带宽值。', + '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' => '实例ID，可调用[DescribeInstances](~~473778~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'TargetIntranetBandwidth', + 'in' => 'query', + 'schema' => [ + 'description' => '实例总目标带宽值。'."\n" + .'> 如果实例是集群版实例，总目标带宽值要能整除实例分片数量。新架构读写分离实例暂不支持此操作。>', + 'type' => 'string', + 'required' => true, + 'example' => '260', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '236934422960904', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '修改实例的带宽', + 'description' => '- 请确保在使用该接口前，已充分了解实例的带宽收费方式和价格。云数据库 Tair（兼容 Redis）会根据增加的带宽量和使用时长，按小时产生费用，不同地域的收费标准有所区别。更多信息，请参见[计费项](~~54532~~)。'."\n" + .'- 实例（或单分片）最多支持额外增加原实例默认带宽的6倍，但增加的上限为192 MB/s。例如Tair内存型2 GB标准架构的默认带宽为96 MB/s，该规格最多可增加192 MB/s，最终实例带宽上限为288 MB/s；Redis开源版256 MB标准架构的默认带宽为10 MB/s，该规格最多可增加60 MB/s，最终实例带宽上限为70 MB/s。', + ], + 'ModifyTaskInfo' => [ + 'summary' => '进行任务操作，当前支持修改任务执行时间点。', + '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' => '实例所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID，如需查询多个请用英文逗号（,）分隔，最多支持30个。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 't-0mq3kfhn8i1nlt****', + ], + ], + [ + 'name' => 'StepName', + 'in' => 'query', + 'schema' => [ + 'description' => '当前执行的步骤名。您可以通过[DescribeHistoryTasks](~~2400077~~)查询指定任务ID当前的执行步骤。常见取值**do_pause**表示等待预设时间执行。', + 'type' => 'string', + 'required' => false, + 'example' => 'do_pause', + ], + ], + [ + 'name' => 'TaskAction', + 'in' => 'query', + 'schema' => [ + 'description' => '操作名称，当前支持取值**modifySwitchTime**，表示修改切换时间或恢复时间。', + 'type' => 'string', + 'required' => false, + 'example' => 'modifySwitchTime', + ], + ], + [ + 'name' => 'ActionParams', + 'in' => 'query', + 'schema' => [ + 'description' => '动作相关的参数，Json格式。'."\n" + .'当**TaskAction**取值**modifySwitchTime**时，本参数ActionParams取值为 `{"recoverMode": "xxx", "recoverTime": "xxx"}`。'."\n" + .'* **recoverMode**表示任务恢复模式，取值为：'."\n" + .' * **imePoint**：按照指定时间点执行。'."\n" + .' * **immediate**: 立即执行。'."\n" + .' * **maintainTime**：按照运维时间执行。'."\n" + ."\n" + .'* **recoverTime**表示指定的时间点，UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ，当**recoverMode**为**timePoint**时，该参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '{"recoverMode":"immediate"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2B98499B-E62B-56D4-8D7F-3D6D4DB260F2', + ], + 'ErrorTaskId' => [ + 'description' => '失败的任务ID，遇到一个失败即返回。', + 'type' => 'string', + 'example' => 't-0mqaj5hnyofczv****', + ], + 'SuccessCount' => [ + 'description' => '成功任务数。', + 'type' => 'string', + 'example' => '2', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '修改任务操作', + ], + 'ModifyBackupExpireTime' => [ + 'summary' => '延长手动备份数据的过期时间。', + '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' => '实例的备份文件ID。您可以调用[DescribeBackups](~~473823~~)进行查询。', + 'type' => 'string', + 'required' => false, + 'example' => '521****66', + ], + ], + [ + 'name' => 'ExpectExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => '需要延长至指定时间点，格式为yyyy-MM-ddTHH:mmZ（UTC 时间），该时间点不能早于当前过期时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2025-07-06T07:25:57Z', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + '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' => '请求ID。', + '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' => '延长手动备份数据的过期时间', + ], + 'DeleteBackup' => [ + 'summary' => '删除指定备份集，但仅支持删除手动备份的备份集。', + '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' => '实例的备份文件ID。您可以调用[DescribeBackups](~~473823~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '521****66', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的ID，可调用[DescribeInstances](~~473778~~)获取。', + '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' => '请求ID。', + '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' => '删除备份集', + 'description' => '* 本操作仅支持云原生版实例。', + ], + 'CreateTairKVCacheVNode' => [ + 'summary' => '创建Tair VNode虚拟节点实例', + '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' => '地域ID。使用此参数指定要创建实例的地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。使用此参数指定要创建实例的可用区。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing-f', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '新的实例名称。名称为2~80个字符，以大小写英文字母或中文开头，不支持空格及特殊字符：`@/:=”<>{[]}`。', + 'type' => 'string', + 'required' => false, + 'example' => 'vnodetest', + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'kvcache.cu.g4b.2'."\n", + ], + ], + [ + 'name' => 'ComputeUnitNum', + 'in' => 'query', + 'schema' => [ + 'description' => '计算单元数量，目前仅支持1个计算单元', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1', + 'minimum' => '1', + 'enumValueTitles' => [ + 1 => '1', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'VkName', + 'in' => 'query', + 'schema' => [ + 'description' => 'VNode所在VCluster虚拟集群实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'tk-2ze4bba3c8fe****'."\n", + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '本实例的虚拟交换机ID，需要从属于指定VCluster虚拟集群的专有网络VPC，可调用专有网络VPC的[DescribeVpcs](~~35739~~)获取。'."\n" + .'> 虚拟交换机所属的可用区需和本实例相同。', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '要转换到的付费类型，取值：'."\n" + .'* **PrePaid**：包年包月，传入本值时，您还需要传入**Period**参数。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PrePaid' => 'PrePaid', + ], + 'example' => 'PrePaid', + 'default' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '付费周期，单位为月，取值：**1**~**9**、**12**、**24**、**36**。'."\n" + .'> 当**ChargeType**取值为**PrePaid**时，本参数必须传入。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BusinessInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '活动ID、业务信息等扩展信息。', + 'type' => 'string', + 'required' => false, + 'example' => '000000000'."\n", + ], + ], + [ + 'name' => 'CouponNo', + 'in' => 'query', + 'schema' => [ + 'description' => '优惠码。', + 'type' => 'string', + 'required' => false, + 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'default' => 'default', + ], + ], + [ + 'name' => 'AutoUseCoupon', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用代金券，取值：'."\n" + .'* **true**：使用代金券。'."\n" + .'* **false**（默认）：不使用代金券。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费，取值：'."\n" + .'* **true**：开启。'."\n" + .'* **false**（默认）：不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费周期，单位为月，取值：**1**、**2**、**3**、**6**、**12**。'."\n" + .'> 当**AutoRenew**取值为**true**时，本参数必须传入。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标资源组ID。'."\n" + ."\n" + .'> * 您可以通过调用[ListResourceGroups](~~158855~~)接口或通过控制台获取资源组ID列表。相关操作，请参见[查看资源组基本信息](~~151181~~)。'."\n" + .'> * 修改实例所属的资源组之前，您可以调用[ListResources](~~158866~~)接口查看实例现在所属的资源组。', + 'type' => 'string', + 'required' => false, + 'maximum' => '4096', + 'minimum' => '1', + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => [ + 'description' => '自动支付，取值固定为**true**', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + 'enum' => [ + 'true', + ], + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感、不超过64个ASCII字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'ETnLKlblzczshOTUbOCz****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例的标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键，与Tag Value组成标签的键值对。'."\n" + .'> 单次最多支持传入5组标签的键值对。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1_test', + ], + 'Value' => [ + 'description' => '标签的值。'."\n" + .'> **N**表示传入第几个标签的值。例如**Tag.1.Value**表示传入第一个标签的值；**Tag.2.Value**表示传入第二个标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1_test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对本次创建实例的操作执行预检查，取值：'."\n" + .'* **true**：执行预检查操作，不创建实例。检查项目包含请求参数、请求格式、业务限制和库存。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'* **false**（默认）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'VNodeType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'fixed', + 'enum' => [ + 'fixed', + 'elastic', + ], + ], + ], + [ + 'name' => 'ElasticTimeRange', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', + ], + 'InstanceId' => [ + 'description' => '虚拟节点实例ID。', + 'type' => 'string', + 'example' => 'tv-2zeb1ce76fee****', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20905403119****', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-beijing-f', + ], + 'VkName' => [ + 'description' => '虚拟集群实例ID', + 'type' => 'string', + 'example' => 'tk-2ze4bba3c8fe****'."\n", + ], + 'VClusterId' => [ + 'description' => '虚拟集群ID', + 'type' => 'string', + 'example' => 'vc-16965a9267*****-*****', + ], + 'NodeId' => [ + 'description' => '虚拟节点ID', + 'type' => 'string', + 'example' => 'vn-03a49876edb****', + ], + ], + ], + ], + ], + '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' => '创建Tair KVCache VNode实例', + ], + 'DescribeTairKVCacheInferInstances' => [ + 'summary' => '查询一个或多个Tair KVCache实例的信息。', + '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' => '实例所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的实例ID。'."\n" + .'> 如需传入多个实例ID时，使用英文逗号（,）分隔实例ID，最多一个请求传入 30 个实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'tk-2zefe7728c2c****', + ], + ], + [ + 'name' => 'InstanceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '实例状态，取值：'."\n" + .'* **Normal**：正常。'."\n" + .'* **Creating**：创建中。'."\n" + ."\n" + .'> 更多实例状态及详细信息，请参见[实例状态与影响](~~200740~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的付费类型，取值：'."\n" + .'- **PrePaid**：预付费，包年包月。'."\n" + .'- **PostPaid**：后付费，按量付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'NetworkType', + 'in' => 'query', + 'schema' => [ + 'description' => '网络类型，取值：'."\n" + .'* **VPC**：专有网络，默认值。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + 'enum' => [ + 'CLASSIC', + 'VPC', + ], + ], + ], + [ + 'name' => 'InstanceClass', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格', + 'type' => 'string', + 'required' => false, + 'example' => 'kvcache.cu.g4c.2', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1nme44gek34slfc****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1e7clcw529l773d****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '实例列表的页码，起始值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，默认为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '0', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '支持模糊搜索实例名称或实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'apitest', + ], + ], + [ + 'name' => 'Expired', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的过期状态，取值：'."\n" + ."\n" + .'* **true**：已过期。'."\n" + .'* **false**：未过期。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-e', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID，可以为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyiu4ekp****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例的标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键，与Tag Value组成标签的键值对。'."\n" + .'> 单次最多支持传入5组标签的键值对。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1_test', + ], + 'Value' => [ + 'description' => '标签的值。'."\n" + .'> **N**表示传入第几个标签的值。例如**Tag.1.Value**表示传入第一个标签的值；**Tag.2.Value**表示传入第二个标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'PrivateIp', + 'in' => 'query', + 'schema' => [ + 'description' => '专有网络IP地址。该参数已弃用。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.49.***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CD225838-7069-5CE4-89E1-67B83AC149C8', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页返回的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Instances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TairInferInstanceDTO' => [ + 'description' => 'Tair KVCache实例信息列表内容。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络VPC ID。', + 'type' => 'string', + 'example' => 'vpc-2zef5w848p4j5g***', + ], + 'CreateTime' => [ + 'description' => '实例的创建时间。', + 'type' => 'string', + 'example' => '2025-04-07T04:46Z', + ], + 'ChargeType' => [ + 'description' => '付费类型。', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'NetworkType' => [ + 'description' => '网络类型。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'kvcache-7', + ], + 'InstanceClass' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => 'kvcache.cu.g4b.2', + ], + 'DestroyTime' => [ + 'description' => '销毁实例的时间。', + 'type' => 'string', + 'example' => '2025-04-07T04:46Z'."\n", + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'tk-9dp7e37bab*****', + ], + 'InstanceType' => [ + 'description' => '实例类型，返回值：'."\n" + .'* **TairInfer**：推理算子实例'."\n" + .'* **TairKVCacheVnode**：虚拟集群实例。'."\n" + .'* **TairKVCacheService**：缓存服务实例。', + 'type' => 'string', + 'example' => 'TairInfer', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'EndTime' => [ + 'description' => '预付费实例到期时间。', + 'type' => 'string', + 'example' => '2025-11-04T02:09:26Z', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-8vbf0ksk774ai6q1d****', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfm4bdru5z****', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-g', + ], + 'InstanceStatus' => [ + 'description' => '实例状态，取值：'."\n" + .'* **Normal**：正常。'."\n" + .'* **Creating**：创建中。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '实例的标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag的Key。', + 'type' => 'string', + 'example' => 'thread', + ], + 'Value' => [ + 'description' => '标签value。', + 'type' => 'string', + 'example' => '900', + ], + ], + ], + ], + ], + ], + 'PrivateIp' => [ + 'description' => '专有网络IP地址。该参数已弃用。', + 'type' => 'string', + 'example' => '172.16.49.***', + ], + 'Capacity' => [ + 'description' => 'KVCache存储容量。单位GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '256', + ], + 'Model' => [ + 'description' => '推理算子实例的内置模型。', + 'type' => 'string', + 'example' => 'DeepSeek-OCR', + ], + 'ModelServiceNum' => [ + 'description' => '推理算子实例的模型服务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ComputeUnitNum' => [ + 'description' => '计算单元数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VNodeName' => [ + 'description' => '虚拟集群实例下属VNode实例名列表。该参数已弃用。', + 'type' => 'string', + 'example' => 'tv-xxxxx', + ], + 'AckId' => [ + 'description' => '虚拟集群实例对应的ACK ID。', + 'type' => 'string', + 'example' => 'c809******************************', + ], + 'VNodeCount' => [ + 'description' => '虚拟集群实例下的虚拟节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'FixedVNodeCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ElasticVNodeCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询Tair KVCache实例的列表信息', + 'description' => '本接口支持查询Tair KVCache的推理算子实例、虚拟集群实例、缓存服务实例。', + ], + 'TransformToEcs' => [ + 'summary' => '转换本地盘到云原生', + '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' => '转换目标云原生实例的规格，详细信息请参见[规格查询导航](~~26350~~)。'."\n" + ."\n" + .'> 这是说明的内容'."\n" + .'> - 集群实例需要传入对应云原生带 with.proxy 的集群规格，同时需要指定分片数量 ShardCount 参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'tair.rdb.1g'."\n" + .'tair.rdb.with.proxy.1g', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '要转换到的付费类型，取值：'."\n" + .'* **PostPaid**：按量付费。'."\n" + .'* **PrePaid**：包年包月，传入本值时，您还需要传入**Period**参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'default' => 'PostPaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '包年包月的付费时长，单位为月，取值：**1**~**9**、**12**、**24**、**36**。'."\n" + .'> 当**ChargeType**参数取值为**PrePaid**时，本参数才可用且必须传入。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ShardCount', + 'in' => 'query', + 'schema' => [ + 'description' => '云原生集群实例中的数据分片节点的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '要做转换的经典实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '实例兼容Redis的版本，**5.0**、**6.0**或**7.0**。', + 'type' => 'string', + 'required' => true, + 'example' => '5.0', + 'enum' => [ + '5.0', + '6.0', + '7.0', + ], + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '数据迁移后执行数据库切换的时间，取值： '."\n" + .'* **Immediately**：迁移完立即切换。'."\n" + .'* **MaintainTime**：在可维护时间段内切换。'."\n" + ."\n" + .'> 默认值：**Immediately**。', + 'type' => 'string', + 'required' => false, + 'example' => 'Immediately', + 'default' => 'Immediately', + 'enum' => [ + 'Immediately', + 'MaintainTime', + ], + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动续费。取值：'."\n" + ."\n" + .'* **true**：开启'."\n" + .'* **false**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '自动续费周期，单位为月，取值：**1**、**2**、**3**、**6**、**12**。'."\n" + ."\n" + .'> 当**AutoRenew**取值为**true**时，本参数必须传入。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'enum' => [ + '1', + '2', + '3', + '6', + '12', + ], + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否对本次创建实例的操作执行预检查，取值：'."\n" + .'* **true**：执行预检查操作，不创建云原生实例。检查项目包含请求参数、请求格式、业务限制和库存。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'* **false**（默认）：发送正常请求，通过检查后直接创建实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + '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' => 'DAABAD9B-890F-56C0-806C-6144946594AB', + ], + 'OrderId' => [ + 'description' => '订单ID。', + 'type' => 'string', + 'example' => '20905403119****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DAABAD9B-890F-56C0-806C-6144946594AB\\",\\n \\"OrderId\\": \\"20905403119****\\"\\n}","type":"json"}]', + 'title' => '经典架构转换至云原生', + ], + 'ModifyDBInstanceMonitor' => [ + 'summary' => '修改Tair实例的监控采集粒度', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '56473', + 'abilityTreeNodes' => [ + 'FEATUREkvstoreW1V0SW', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'r-bp1zxszhcgatnx****', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '监控数据的采集粒度，单位为秒，取值5或60', + 'type' => 'string', + 'required' => true, + 'example' => '5', + 'enum' => [ + '5', + '60', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2BE6E619-A657-42E3-AD2D-18F8428A****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BE6E619-A657-42E3-AD2D-18F8428A****\\"\\n}","type":"json"}]', + 'title' => '修改Tair实例的监控采集粒度', + ], + 'DescribeTags' => [ + 'summary' => '查询目标地域中所有的标签信息。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值为**INSTANCE**或**instance**。', + 'type' => 'string', + 'required' => false, + 'example' => 'INSTANCE', + 'default' => 'INSTANCE', + 'enum' => [ + 'INSTANCE', + 'instance', + ], + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始Token，用来返回更多结果。'."\n" + .'> 第一次查询不需要提供本参数，如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的**NextToken**值以继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => '212db86sca4384811e0b5e8707ec2****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一个查询开始 Token。'."\n" + .'> 如果一次查询没有返回全部结果，则会返回本参数，您可以后续查询中传入本参数的值以继续查询。', + 'type' => 'string', + 'example' => '212db86sca4384811e0b5e8707ec2****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F3F44BE3-5419-4B61-9BAC-E66E295A****', + ], + 'Tags' => [ + 'description' => '标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => '标签的键。', + 'type' => 'string', + 'example' => 'size', + ], + 'TagValues' => [ + 'description' => '标签的值。', + 'type' => 'array', + 'items' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => '[\'test_value_2\']', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询已有标签列表', + ], + 'DescribeDbInstanceConnectivity' => [ + 'summary' => '检测源客户端IP到实例的联通性。', + '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' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'r-bp1r36hdqlrgt1****', + ], + ], + [ + 'name' => 'SrcIp', + 'in' => 'query', + 'schema' => [ + 'description' => '用户源IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '124.207.240.***', + ], + ], + ], + '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' => '2BE6E619-A657-42E3-AD2D-18F8428A****', + ], + 'ConnCheckResult' => [ + 'description' => '连接诊断结果。取值范围如下：'."\n" + .'* **Success**'."\n" + .'* **Failed**', + 'type' => 'string', + 'example' => 'Failed', + ], + 'ConnCheckErrorCode' => [ + 'description' => '连接诊断错误码。取值范围如下：'."\n" + .'* **SRC_IP_NOT_IN_USER_WHITELIST**：源IP地址没有加入白名单。'."\n" + .'* **CONNECTION_ABNORMAL**：连接正常。', + 'type' => 'string', + 'example' => 'SRC_IP_NOT_IN_USER_WHITELIST', + ], + 'ConnCheckErrorMessage' => [ + 'description' => '连接诊断错误信息。', + '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' => '获取实例链路诊断信息', + ], + ], + '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', + ], + ], +]; -- cgit v1.2.3