API Descriptions

<p><strong>1. ClearRedisCluster</strong></p> <p><strong>Description</strong></p> <p>Clears a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job ID.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>2. CreateRedisCluster</strong></p> <p><strong>Description</strong></p> <p>Creates a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region ID. To view the region list, use ListRegions.</p> </td> </tr> <tr> <td> <p>MasterZoneCode</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Production availability zone. To view the list of availability zones, use DescribeRedisZones.</p> </td> </tr> <tr> <td> <p>SlaveZoneCode</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Citywide availability zone. It cannot be the same as the production availability zone. To view the list of availability zones, use DescribeRedisZones.</p> </td> </tr> <tr> <td> <p>RemoteSlaveZoneCode</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Remote availability zone. It cannot be the same as the production availability zone. To view the list of availability zones, use DescribeRedisZones.</p> </td> </tr> <tr> <td> <p>Engine</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Database type. Type list: PostgreSQL, MySQL, Redis, and MongoDB.</p> </td> </tr> <tr> <td> <p>EngineVersion</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Database version number. To view the list of version numbers, use DescribeRedisVersions.</p> </td> </tr> <tr> <td> <p>DbInstanceClass</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance specification. To view the specification list, use DescribeRedisClusterClass.</p> </td> </tr> <tr> <td> <p>Password</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Password. It must include 8 to 32 characters. Required characters are uppercase letters, lowercase letters, and digits.</p> </td> </tr> <tr> <td> <p>ChargeType</p> </td> <td> <p>ChargeType</p> </td> <td> <p>true</p> </td> <td> <p>Payment method:</p> <p>&bull;&nbsp;&nbsp;&nbsp;<strong>Hour</strong>&mdash;Pay by hour.</p> <p>&bull;&nbsp; &nbsp;<strong>Usage</strong>&mdash;Pay-as-you-go.</p> <p>&bull;&nbsp;&nbsp;&nbsp;<strong>PreUsage</strong>&mdash;On-demand subscription.</p> <p>&bull;&nbsp;&nbsp;&nbsp;<strong>Monthly</strong>&mdash;Monthly subscription.</p> <p>&bull;&nbsp;&nbsp;&nbsp;<strong>Free</strong>&mdash;Free of charge.</p> <p>&bull;&nbsp; &nbsp;<strong>Annual</strong>&mdash;Annual subscription.</p> </td> </tr> <tr> <td> <p>PayType</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Payment type: Prepaid or Postpaid.</p> </td> </tr> <tr> <td> <p>Period</p> </td> <td> <p>Integer</p> </td> <td> <p>false</p> </td> <td> <p>Purchase duration. The value range is 1 to 60.</p> </td> </tr> <tr> <td> <p>Count</p> </td> <td> <p>Integer</p> </td> <td> <p>true</p> </td> <td> <p>Quantity. The value range is 1 to 5.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>OrderId</p> </td> <td> <p>String</p> </td> <td> <p>Order ID.</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>OrderStatus</p> </td> <td> <p>Order status.</p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>Product code.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>3. CreateRedisWhiteList</strong></p> <p><strong>Description</strong></p> <p>Creates a Redis whitelist entry.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> <tr> <td> <p>AddCidr</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>CIDR. Multiple CIDRs are separated by half-width commas (,). For example, 127.0.0.1/23,127.0.0.1/29.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>JobIds</p> </td> <td> <p>List&lt;String&gt;</p> </td> <td> <p>Job ID list.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>4. DeleteRedisWhiteList</strong></p> <p><strong>Description</strong></p> <p>Deletes a Redis whitelist entry.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>WhiteListId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Whitelist ID. To view the whitelist, use DescribeRedisWhiteLists.</p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job ID.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>5. DescribeRedisClusterAttribute</strong></p> <p><strong>Description</strong></p> <p>Queries details of a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstance</p> </td> <td> <p>DbInstanceDetailBean</p> </td> <td> <p>Details of the Redis cluster.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>6. DescribeRedisClusterCanUpgradeClass</strong></p> <p><strong>Description</strong></p> <p>Queries the versions to which the Redis cluster can be upgraded.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>Combos</p> </td> <td> <p>List&lt;ComboBean&gt;</p> </td> <td> <p>List of computing specifications.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>7. DescribeRedisClusterClass</strong></p> <p><strong>Description</strong></p> <p>Queries the computing specifications of a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region ID. To view the region list, use ListRegions.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>Combos</p> </td> <td> <p>List&lt;ComboBean&gt;</p> </td> <td> <p>List of computing specifications.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>8. DescribeRedisClusterSpecUnitPrice</strong></p> <p><strong>Description</strong></p> <p>Queries the unit prices of the computing specifications of a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region ID.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>UnitPrices</p> </td> <td> <p>List&lt;UnitPriceBean&gt;</p> </td> <td> <p>Price list.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>9. DescribeRedisClusters</strong></p> <p><strong>Description</strong></p> <p>Queries the Redis cluster list.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region ID. To view the region list, use ListRegions.</p> </td> </tr> <tr> <td> <p>Engine</p> </td> <td> <p>EngineType</p> </td> <td> <p>true</p> </td> <td> <p>Database type.</p> </td> </tr> <tr> <td> <p>State</p> </td> <td> <p>RedisInstanceStatus</p> </td> <td> <p>false</p> </td> <td> <p>Status.</p> </td> </tr> <tr> <td> <p>DbInstanceTag</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Instance tag.</p> </td> </tr> <tr> <td> <p>MasterZoneCode</p> </td> <td> <p>String</p> </td> <td> <p>false</p> </td> <td> <p>Production availability zone. To view the list of availability zones, use DescribeRedisZones.</p> </td> </tr> <tr> <td> <p>PageNum</p> </td> <td> <p>Integer</p> </td> <td> <p>false</p> </td> <td> <p>Page number.</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>false</p> </td> <td> <p>Maximum number of rows displayed per page.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstances</p> </td> <td> <p>List&lt;DbInstanceBean&gt;</p> </td> <td> <p>Instance list.</p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Integer</p> </td> <td> <p>Total number.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>10. DescribeRedisCurrentTaskProcess</strong></p> <p><strong>Description</strong></p> <p>Queries the back-end tasks in progress.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> <tr> <td> <p>PageNum</p> </td> <td> <p>Integer</p> </td> <td> <p>false</p> </td> <td> <p>Page number. The starting value is 1. The default value is 1.</p> </td> </tr> <tr> <td> <p>PageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>false</p> </td> <td> <p>Maximum number of rows displayed per page. The value must be more than 1. The default value is 1000.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>TotalCount</p> </td> <td> <p>Long</p> </td> <td> <p>Total number.</p> </td> </tr> <tr> <td> <p>TaskProcess</p> </td> <td> <p>List&lt;TaskProcessBean&gt;</p> </td> <td> <p>Task list.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>11. DescribeRedisMasterSlaveSync</strong></p> <p><strong>Description</strong></p> <p>Queries the synchronization status between the master and subordinate nodes.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region ID. To view the region list, use ListRegions.</p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>Detail</p> </td> <td> <p>RedisMasterSlaveSyncBean</p> </td> <td> <p>Synchronization status between the master and subordinate nodes.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>12. DescribeRedisParams</strong></p> <p><strong>Description</strong></p> <p>Queries the Redis parameter list.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region ID. To view the region list, use ListRegions.</p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>ParamList</p> </td> <td> <p>List&lt;ParamBean&gt;</p> </td> <td> <p>Parameter list.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>13. DescribeRedisSubnetsByTenantId</strong></p> <p><strong>Description</strong></p> <p>Gets all subnets of the tenant.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region ID.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>Subnets</p> </td> <td> <p>List&lt;SubnetBean&gt;</p> </td> <td> <p>Subnet list.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>14. DescribeRedisVersions</strong></p> <p><strong>Description</strong></p> <p>Queries the Redis version.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>Engine</p> </td> <td> <p>EngineType</p> </td> <td> <p>true</p> </td> <td> <p>Database type.</p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region ID. To view the region list, use ListRegions.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>Versions</p> </td> <td> <p>List&lt;RedisVersionBean&gt;</p> </td> <td> <p>Version information.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>15. DescribeRedisView</strong></p> <p><strong>Description</strong></p> <p>Queries the Redis overview information.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>RegionIds</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region ID. Multiple regions are separated by half-width commas (,). To view the region list, use ListRegions.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>Views</p> </td> <td> <p>List&lt;RedisViewBean&gt;</p> </td> <td> <p>Overview information.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>16. DescribeRedisWhiteLists</strong></p> <p><strong>Description</strong></p> <p>Queries the Redis whitelist.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>WhiteLists</p> </td> <td> <p>List&lt;WhiteListBean&gt;</p> </td> <td> <p>Whitelist.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>17. DescribeRedisZones</strong></p> <p><strong>Description</strong></p> <p>Queries the availability zones in a region.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region ID. To view the region list, use ListRegions.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>Zones</p> </td> <td> <p>List&lt;ZoneBean&gt;</p> </td> <td> <p>List of availability zones.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>18. DestroyRedisCluster</strong></p> <p><strong>Description</strong></p> <p>Releases a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> <tr> <td> <p>DbInstanceUuid</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance UUID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job ID.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>19. ModifyRedisClusterMaintainTime</strong></p> <p><strong>Description</strong></p> <p>Modifies the maintenance period of a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID.</p> </td> </tr> <tr> <td> <p>MaintainTime</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Customized maintenance period. Format: 9:00-10:00.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job ID.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>20. ModifyRedisClusterParam</strong></p> <p><strong>Description</strong></p> <p>Modifies the parameters of a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> <tr> <td> <p>ParamSet</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>JSON format: {&quot;paramname&quot;: &quot;value&quot;}. To view the parameter list, use DescribeRedisParams.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job ID.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>21. ModifyRedisClusterPass</strong></p> <p><strong>Description</strong></p> <p>Modifies the password of a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID.</p> </td> </tr> <tr> <td> <p>OldPassword</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Old password. It must include 8 to 32 characters. Required characters are uppercase letters, lowercase letters, and digits.</p> </td> </tr> <tr> <td> <p>NewPassword</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>New password. It must include 8 to 32 characters. Required characters are uppercase letters, lowercase letters, and digits.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job ID.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>22. ModifyRedisClusterSpec</strong></p> <p><strong>Description</strong></p> <p>Modifies the computing specification of a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> <tr> <td> <p>DbInstanceClass</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance specification. To view the specification list, use DescribeRedisClusterClass.</p> </td> </tr> <tr> <td> <p>CouponId</p> </td> <td> <p>Long</p> </td> <td> <p>false</p> </td> <td> <p>Voucher ID. To Query voucher list, use /payment/coupons/listAvailableCoupons.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>Product code.</p> </td> </tr> <tr> <td> <p>OrderId</p> </td> <td> <p>String</p> </td> <td> <p>Order ID.</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>OrderStatus</p> </td> <td> <p>Order status.</p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>Product code.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>23. ModifyRedisClusterTag</strong></p> <p><strong>Description</strong></p> <p>Modifies the tag of a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> <tr> <td> <p>DbInstanceTag</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance tag. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>String</p> </td> <td> <p>Status.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>24. RedisExport</strong></p> <p><strong>Description</strong></p> <p>Exports the data of the cluster list.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>RowNames</p> </td> <td> <p>String[]</p> </td> <td> <p>true</p> </td> <td> <p>Column name. Available columns: dbInstanceId, dbInstanceName, dbInstanceTag, engine, engineVersion, comboCode, state, chargeType, Period, password, regionCode, regionName, masterZoneCode, masterZoneName, connVip, connPort, domainName, maintainTime, createUser, createTime, expireDate, isExpired, tenantId, and tenantName.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>25. RenewRedisCluster</strong></p> <p><strong>Description</strong></p> <p>Renews a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceUuid</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance UUID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> <tr> <td> <p>Period</p> </td> <td> <p>Integer</p> </td> <td> <p>true</p> </td> <td> <p>Renewal period. The value range is 1 to 36.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>OrderId</p> </td> <td> <p>String</p> </td> <td> <p>Order ID.</p> </td> </tr> <tr> <td> <p>Status</p> </td> <td> <p>OrderStatus</p> </td> <td> <p>Order status.</p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>Product code.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>26. RestartRedisCluster</strong></p> <p><strong>Description</strong></p> <p>Restarts a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job ID.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>27. CheckRedisResource</strong></p> <p><strong>Description</strong></p> <p>Verifies Redis resources.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region ID. To view the region list, use ListRegions.</p> </td> </tr> <tr> <td> <p>ZoneCode</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Availability zone.</p> </td> </tr> <tr> <td> <p>ComboCode</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Computing specification.</p> </td> </tr> <tr> <td> <p>Count</p> </td> <td> <p>Integer</p> </td> <td> <p>true</p> </td> <td> <p>Purchase quantity.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>Count</p> </td> <td> <p>Int</p> </td> <td> <p>Number of instances that can be created.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>28. DescribeRedisRemoteRegions</strong></p> <p><strong>Description</strong></p> <p>Queries a remote region</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>RegionId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Region ID. To view the region list, use ListRegions.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>Regions</p> </td> <td> <p>List&lt;RegionBean&gt;</p> </td> <td> <p>Region list.</p> </td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>29.</strong> <strong>DescribeRedisUpgradeableVersions</strong></p> <p><strong>Description</strong></p> <p>Queries the list of all small versions to which the Redis cluster can be upgraded.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID.</p> </td> </tr> <tr> <td> <p>Engine</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Database type.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>VersionList</p> </td> <td> <p>List&lt; RedisVersionBean&gt;</p> </td> <td> <p>Version list.</p> </td> </tr> </tbody> </table> <p><strong>&nbsp;</strong></p> <p><strong>30.</strong> <strong>DowngradeRedisClusterSpecAction</strong></p> <p><strong>Description</strong></p> <p>Downgrades the specification of a Redis instance.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID. To view the instance list, use DescribeRedisClusters.</p> </td> </tr> <tr> <td> <p>DbInstanceClass</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance specification. To view the specification list, use DescribeRedisClusters.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>ProductCode</p> </td> <td> <p>String</p> </td> <td> <p>Product code.</p> </td> </tr> </tbody> </table> <p><strong>&nbsp;</strong></p> <p><strong>31. ModifyRedisClusterAutoRenewFlag</strong></p> <p><strong>Description</strong></p> <p>Enables or disables auto renewal of an instance.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>InstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID.</p> </td> </tr> <tr> <td> <p>AutoRenewFlag</p> </td> <td> <p>Boolean</p> </td> <td> <p>true</p> </td> <td> <p>Enables or disables auto renewal.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> </tbody> </table> <p><strong>32.</strong> <strong>UpdateRedisClusterVersion</strong></p> <p><strong>Description</strong></p> <p>Upgrades a Redis cluster.</p> <p><strong>Request Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Required</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>DbInstanceId</p> </td> <td> <p>String</p> </td> <td> <p>true</p> </td> <td> <p>Instance ID.</p> </td> </tr> <tr> <td> <p>EngineVersion</p> </td> <td> <p>Boolean</p> </td> <td> <p>true</p> </td> <td> <p>Version number.</p> </td> </tr> </tbody> </table> <p><strong>Response Parameters</strong></p> <table border="1" cellpadding="0" cellspacing="0" style="width:100%"> <tbody> <tr> <td> <p><strong>Name</strong></p> </td> <td> <p><strong>Type</strong></p> </td> <td> <p><strong>Description</strong></p> </td> </tr> <tr> <td> <p>JobId</p> </td> <td> <p>String</p> </td> <td> <p>Job ID.</p> </td> </tr> </tbody> </table>
Did the above content solve your problem? Yes No
Please complete information!

Call us

400-151-8800

Email us

cloud@pingan.com

Online customer service

Instant reply

Technical Support

cloud products