# Alibaba Cloud Tair (Redis® OSS-Compatible) API

> Alibaba Cloud Tair (Redis® OSS-Compatible) API on Apizie: 166 endpoints (Adds data shard nodes to a cluster instance. This operation supports only cloud-native Cluster Edition…, Applies for a direct connection endpoint for an ApsaraDB Tair (Redis® OSS-Compatible) database cluster…, Applies for a public endpoint for a Tair (Redis® OSS-Compatible) instance, Cancels O&M events in batches, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-r-kvstore/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-r-kvstore`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/r-kvstore
- Page: https://apizie.tech/api/cloud/aliyun-r-kvstore
- OpenAPI: https://apizie.tech/api/cloud/aliyun-r-kvstore/openapi.json

Alibaba Cloud OpenAPI for Tair (Redis® OSS-Compatible) (r-kvstore, version 2015-01-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds data shard nodes to a cluster instance. This operation supports only cloud-native Cluster Edition…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/add-sharding-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ShardCount | integer | no | The number of shards to add. Default value: 1. The minimum total number of shards for an instance is 2. You can add up to 64 shards in a… |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: Automatic payment is enabled. Make sure that your account has… |
| CouponNo | string | no | The coupon code |
| BusinessInfo | string | no | The additional parameter for business information |
| SourceBiz | string | no | The request source. This parameter is used only for internal maintenance and does not need to be specified |
| ForceTrans | string | no | Specifies whether to enable forced transmission. Valid values: false (default): Before the Upgrade/Downgrade, the system checks the… |
| VSwitchId | string | no | The ID of a different vSwitch within the same VPC. The new data shards are created under the specified vSwitch. If you leave this… |

### Applies for a direct connection endpoint for an ApsaraDB Tair (Redis® OSS-Compatible) database cluster…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/allocate-direct-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. Only cluster instances deployed in classic mode are supported. For instances deployed in classic mode, the value of the… |
| ConnectionString | string | no | The prefix of the direct connection endpoint. The prefix must be 8 to 40 characters in length and can contain lowercase letters and… |
| Port | string | no | The port number. Valid values: 1024 to 65535. Default value: 6379 |

### Applies for a public endpoint for a Tair (Redis® OSS-Compatible) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/allocate-instance-public-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ConnectionStringPrefix | string | yes | The prefix of the public endpoint. The prefix must start with a lowercase letter and can contain lowercase letters and digits. The prefix… |
| Port | string | yes | The service port number of the instance. Valid values: 1024 to 65535 |

### Cancels O&M events in batches
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/cancel-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| Ids | string | yes | The IDs of the O&M events to cancel in batches. Separate multiple IDs with commas (,) |

### Disables an AI assistant inspection task
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/cancel-inspection-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| TaskId | string | no | The TaskId |
| InstanceId | string | yes | The instance ID |

### Queries whether an ApsaraDB for Redis (Tair) instance has been granted authorization to use the Key…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/check-cloud-resource-authorized` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/473778.html to query the instance ID |
| RoleArn | string | no | The global resource descriptor Alibaba Cloud Resource Name (ARN) of the role to be authorized. After the role is granted authorization,… |

### Creates an account for an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| AccountName | string | yes | The account name. The name must meet the following requirements: The name starts with a lowercase letter and can contain lowercase… |
| AccountPrivilege | string | no | The permissions of the account. Valid values: RoleReadOnly: read-only permissions. RoleReadWrite: read and write permissions. This is the… |
| AccountPassword | string | yes | The password of the account. The password must be 8 to 32 characters in length and contain at least three of the following character… |
| AccountDescription | string | no | The description of the account. The description must start with a Chinese character or an English letter. It cannot start with `http: //`… |
| AccountType | string | no | The account type. Set the value to Normal (standard account) |
| SourceBiz | string | no | This parameter is used only for internal maintenance. You do not need to specify this parameter |
| Parameters | string | no | The account parameters to modify in JSON format. The new values overwrite the original values. This parameter is supported only for Tair… |

### Creates a data backup for an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| BackupRetentionPeriod | integer | no | The retention period of this manual backup. Valid values: 7 to 730. Unit: days. If you set this parameter to -1, the manual backup does… |

### Manually initiates a cache analysis task for an instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-cache-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/473778.html to obtain the instance ID |

### Converts an existing Tair memory-optimized (Classic Edition) instance into the first child instance of a…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-global-distribute-cache` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| SeedSubInstanceId | string | yes | The instance ID to be transformed |
| ResourceGroupId | string | no | The ID of the resource group. You do not need to specify this system parameter |
| EffectiveTime | string | no | The time when the operation is executed. Valid values: Immediately: Executes the operation immediately. MaintainTime: Executes the… |

### Creates a global IP address whitelist template
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-global-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| RegionId | string | yes | The region ID |
| GlobalIgName | string | yes | The name of the IP address whitelist template. The name must meet the following requirements: The name can contain lowercase letters,… |
| GIpList | string | yes | The IP addresses in the whitelist template. Separate multiple IP addresses with commas (,). IP addresses cannot be duplicated. You can add… |

### Creates a scheduled inspection task configuration
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-inspection-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| ScheduleName | string | no | The name of the timed scheduling |
| CronExpression | string | no | The cron expression for the periodic scheduling |
| Timezone | string | no | The time zone |
| InstanceIds | string | no | The list of associated instance IDs. Separate multiple instances with commas (,) |
| InspectionItems | string | no | The specified inspection items. The following inspection items are supported: RESOURCE_USAGE BIGKEY HOTKEY PERFORMANCE_METRICS SLOWLOG |
| InspectionWindow | string | no | The time window |
| ReportLanguage | string | no | The report language |
| InstanceId | string | yes | The O&M Assistant instance ID |

### Creates a manual inspection task
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-inspection-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceIds | string | yes | The list of associated instance IDs |
| InspectionItems | string | yes | The specified inspection items. Valid values: RESOURCE_USAGE BIGKEY HOTKEY PERFORMANCE_METRICS SLOWLOG |
| ReportLanguage | string | no | The report language |
| StartTime | string | no | The start time of the inspection time range. The time is in UTC and follows the YYYY-MM-DDTHH:mm:ssZ format |
| EndTime | string | no | The end time of the inspection time range. The time is in UTC and follows the YYYY-MM-DDTHH:mm:ssZ format |
| InstanceId | string | yes | The assistant instance ID |

### Creates an ApsaraDB for Redis Community Edition instance with the classic or cloud-native architecture, or a…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/473763.html operation to query the most recent region list |
| Token | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| InstanceName | string | no | The name of the instance. The name must be 2 to 80 characters in length, and must start with a letter or a Chinese character. It cannot… |
| Password | string | no | The password of the instance. The password must be 8 to 32 characters in length and must contain at least three of the following character… |
| Capacity | integer | no | The storage capacity of the instance. Unit: MB. When you call this operation, you must specify at least one of the Capacity and… |
| InstanceClass | string | no | The instance type. For example, redis.master.small.default indicates a 1 GB Community Edition (classic architecture) instance with the… |
| ZoneId | string | no | The primary active zone ID. You can call the https://help.aliyun.com/document_detail/473763.html operation to query the most recent active… |
| SecondaryZoneId | string | no | The secondary zone ID. You can call the https://help.aliyun.com/document_detail/473764.html operation to query the most recent zone list.… |
| ChargeType | string | no | The billing method. Valid values: PrePaid: subscription. PostPaid (default): pay-as-you-go |
| NodeType | string | no | The node type. Valid values: MASTER_SLAVE: high-availability (two replicas) STAND_ALONE: single replica double: two replicas single:… |
| NetworkType | string | no | The network type. Valid values: VPC: Virtual Private Cloud (VPC). This is the default value |
| VpcId | string | no | The ID of the VPC |
| VSwitchId | string | no | The ID of the vSwitch |
| Period | string | no | The subscription duration. Unit: months. Valid values: 1 to 9, 12, 24, 36, and 60. This parameter is required and takes effect only when… |
| BusinessInfo | string | no | The ID of the promotional event or business information |
| CouponNo | string | no | The coupon code. Default value: `default` |
| SrcDBInstanceId | string | no | If you want to create a new instance based on the backup set of an instance, specify the source instance ID in this parameter first. Then,… |
| BackupId | string | no | You can specify the backup set ID of the source instance in this parameter. The system uses the data saved in the backup set to create the… |
| InstanceType | string | no | The instance type. Valid values: Redis (default) Memcache |
| EngineVersion | string | no | The engine version of the Redis classic instance. Valid values: 2.8 (Not recommended.… |
| PrivateIpAddress | string | no | The internal network IP address of the new instance. The internal network IP address must be within the vSwitch CIDR block to which the… |
| AutoUseCoupon | string | no | Specifies whether to use a voucher. Valid values: true: uses a voucher. false (default): does not use a voucher |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal. false (default): disables auto-renewal |
| AutoRenewPeriod | string | no | The auto-renewal epoch. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required when the AutoRenew parameter is set to… |
| ResourceGroupId | string | no | The ID of the resource group |
| RestoreTime | string | no | The point in time to which you want to restore the source instance. If the data flashback feature is enabled for the source instance, you… |
| DedicatedHostGroupId | string | no | The ID of the dedicated cluster. This parameter is required when you create an ApsaraDB for Redis instance in a dedicated cluster |
| ShardCount | integer | no | The number of shards. This parameter applies only to cloud-native instances. You can use this parameter to specify a custom number of… |
| ReplicaCount | integer | no | The number of secondary nodes in the primary zone. This parameter applies only to cloud-native cluster instances with multiple replicas.… |
| SlaveReplicaCount | integer | no | The number of secondary nodes in the secondary zone |
| ReadOnlyCount | integer | no | The number of read-only nodes in the primary zone. This parameter applies only to cloud-native read/write splitting instances. If the… |
| SlaveReadOnlyCount | integer | no | The number of read-only nodes in the secondary zone |
| GlobalInstanceId | string | no | The distributed instance ID. This parameter applies only to the China site. If you want to append the new ApsaraDB for Redis instance as a… |
| GlobalInstance | string | no | Specifies whether to use the new instance as the first child instance of a distributed instance. You can create a distributed instance in… |
| Port | string | no | The service port of the instance. Valid values: 1 to 65535. Default value: 6379 |
| DryRun | string | no | Specifies whether to perform a dry run on the instance creation request. Valid values: true: performs a dry run without creating the… |
| GlobalSecurityGroupIds | string | no | The global IP address whitelist templates of the instance. Separate multiple templates with commas (,). Duplicate templates are not… |
| Appendonly | string | no | The AOF parameter settings of the new instance. Valid values: yes (default): enables AOF persistence. no: shutdown AOF persistence. This… |
| ConnectionStringPrefix | string | no | The prefix of the endpoint. The prefix must be 8 to 40 characters in length and can contain lowercase letters and digits. It must start… |
| ParamGroupId | string | no | The globally unique ID of the parameter template.> This parameter applies only to cloud-native instances. |
| Tag | string | no | The tag information of the instance (JSON-encoded) |
| ClusterBackupId | string | no | The ID of the cluster backup set. Some new cluster architectures support cluster backup set IDs. You can call the… |
| RecoverConfigMode | string | no | Specifies whether to restore the account, kernel parameters, and whitelist information from the original backup set when you create an… |
| InstanceEndpointType | string | no | The type of the endpoint used when you create a cloud-native dual-zone deployment read/write splitting instance. If you do not explicitly… |
| MaintainStartTime | string | no | The start time of the maintenance window for the instance. Specify the time in the HH:mm Z format. The time must be in UTC. For example,… |
| MaintainEndTime | string | no | The end time of the maintenance window for the instance. Specify the time in the HH:mm Z format. The time must be in UTC. For example, if… |

### Creates multiple VIPs for an instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-instance-multi-vip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| AddCount | string | yes | The number of LBs to add |

### Creates multiple ApsaraDB for Tair (Redis OSS-compatible) database Classic Edition instances
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| Instances | string | yes | The configuration information of the new instances. The value must be in JSON format. For more information, see the supplementary… |
| Token | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. This is the default value. false: disables… |
| BusinessInfo | string | no | The extended business information |
| CouponNo | string | no | The coupon code. Default value: `youhuiquan_promotion_option_id_for_blank` |
| EngineVersion | string | no | The Redis-compatible engine version of the instance. Valid values: 4.0 and 5.0. Default value: 5.0 |
| RebuildInstance | string | no | Specifies whether to rebuild and restore the source instance from the recycle bin. Valid values: true: yes. false: no. This is the default… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal. false: disables auto-renewal. This is the default… |
| ResourceGroupId | string | no | The ID of the resource group |

### Creates a parameter template
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| Category | string | yes | The product category. Valid values: standard: Redis Community Edition. enterprise: Tair (Enterprise Edition) |
| EngineType | string | yes | The engine type. Valid values: redis: Redis Community Edition or Tair memory-optimized. tair_pena: Tair persistent memory-optimized.… |
| EngineVersion | string | yes | The compatible version. Valid values: Redis Community Edition supports 5.0, 6.0, and 7.0. Tair memory-optimized is compatible with Redis… |
| ParameterGroupName | string | yes | The name of the parameter template. The name must meet the following requirements: The name can contain letters, digits, and underscores… |
| Parameters | string | yes | A JSON string that consists of parameters and their values, in the following format: {"Parameter 1":"Value of Parameter 1","Parameter… |
| ParameterGroupDesc | string | no | The description of the parameter template. The description can be 0 to 200 characters in length |

### Creates a cloud-native Tair (Enterprise Edition) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-tair-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/473763.html operation to query the most recent region list. Use… |
| InstanceName | string | no | The instance name. The name must meet the following requirements: The name must be 2 to 80 characters in length. The name must start with… |
| Password | string | no | The instance password. The password must meet the following requirements: The password must be 8 to 32 characters in length. The password… |
| InstanceClass | string | yes | The instance type. For more information, see: https://help.aliyun.com/document_detail/2527112.html.… |
| ZoneId | string | no | The primary active zone ID. You can invoke the https://help.aliyun.com/document_detail/473763.html operation to query the most recent… |
| SecondaryZoneId | string | no | The secondary zone ID. You can call the https://help.aliyun.com/document_detail/473763.html operation to query the most recent zone list.… |
| ChargeType | string | no | The billing method. Valid values: PrePaid: subscription. This is the default value. PostPaid: pay-as-you-go |
| VpcId | string | yes | The ID of the virtual private cloud (VPC). You can call the https://help.aliyun.com/document_detail/35739.html operation of the VPC API to… |
| VSwitchId | string | yes | The ID of the vSwitch in the VPC. You can call the https://help.aliyun.com/document_detail/35739.html operation of the VPC API to obtain… |
| Period | integer | no | The subscription duration. Unit: months. Valid values: 1 to 9, 12, 24, 36, and 60. This parameter is required when the ChargeType… |
| BusinessInfo | string | no | The activity ID and business information |
| CouponNo | string | no | The coupon code |
| SrcDBInstanceId | string | no | Instance ID of the source instance. If you want to create an instance based on the backup set of an existing instance, specify instance ID… |
| BackupId | string | no | The ID of the backup set of the source instance. The system uses the data in the specified backup set to create the instance. You can… |
| ClusterBackupId | string | no | The ID of the cluster backup set. Some new cluster architectures support cluster backup set IDs. You can call the… |
| RecoverConfigMode | string | no | Specifies whether to restore the account, kernel parameters, and whitelist from the original backup set when you create an instance by… |
| PrivateIpAddress | string | no | The internal IP address of the instance. The IP address must fall within the CIDR block of the vSwitch to which the instance belongs. You… |
| AutoUseCoupon | string | no | Specifies whether to use a voucher. Valid values: true: uses a voucher. false: does not use a voucher. This is the default value |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal. false: disables auto-renewal. This is the default value |
| AutoRenewPeriod | string | no | The auto-renewal epoch. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required when the AutoRenew parameter is set to… |
| ResourceGroupId | string | no | The ID of the destination resource group. You can invoke the https://help.aliyun.com/document_detail/158855.html operation or use the… |
| AutoPay | string | no | Specifies whether to enable automatic payment. Set the value to true |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| StorageType | string | no | The storage type. Valid values: essd_pl1, essd_pl2, and essd_pl3. This parameter is required only when the InstanceType parameter is set… |
| Storage | integer | no | The storage capacity of the disk-based instance. The valid values vary based on the instance type. For more information, see… |
| ShardType | string | no | The instance edition. Valid values: MASTER_SLAVE: High-availability Edition. This edition uses a primary/secondary architecture to ensure… |
| ShardCount | integer | no | The number of data nodes in the instance. Valid values: 1: creates a https://help.aliyun.com/document_detail/52228.html that has only one… |
| ReplicaCount | integer | no | The number of secondary nodes in the primary zone. This parameter applies only when you create a cloud-native cluster instance with… |
| SlaveReplicaCount | integer | no | The number of secondary nodes in the secondary zone |
| ReadOnlyCount | integer | no | The number of read-only nodes in the primary zone. This parameter applies only when you create a cloud-native read/write splitting… |
| SlaveReadOnlyCount | integer | no | The number of read-only nodes in the secondary zone |
| EngineVersion | string | no | The database engine version. Default value: 1.0. The value varies based on the Tair instance type: Tair_rdb: Tair memory-enhanced… |
| InstanceType | string | yes | The storage medium. Valid values: tair_rdb: memory-enhanced. tair_scm: persistent memory-optimized. tair_essd: disk-based |
| GlobalInstanceId | string | no | Specifies whether to use the new instance as a child instance in a distributed instance. You can use this parameter to create a… |
| Tag | string | no | The tag information of the instance (JSON-encoded) |
| DryRun | string | no | Specifies whether to perform a dry run before you create the instance. Valid values: true: performs a dry run without creating the… |
| Port | integer | no | The service port of the instance. Valid values: 1 to 65535. Default value: 6379 |
| GlobalSecurityGroupIds | string | no | The global IP address whitelist templates of the instance. Separate multiple whitelist templates with commas (,). Each template must be… |
| ParamGroupId | string | no | The ID of the parameter template. The instance is created based on the parameters in the specified template. Each template ID must be unique |
| RestoreTime | string | no | The point in time to which you want to restore the source instance. If the data flashback feature is enabled for the source instance, you… |
| ConnectionStringPrefix | string | no | The prefix of the endpoint. The prefix must be 8 to 40 characters in length and can contain lowercase letters and digits. It must start… |
| InstanceEndpointType | string | no | The endpoint type used when you create a cloud-native Dual-active-zone deployment read/write splitting instance. If you do not specify… |
| MaintainStartTime | string | no | The start time of the maintenance window. Specify the time in the HH:mm Z format. The time must be in UTC. For example, if you want the… |
| MaintainEndTime | string | no | The end time of the maintenance window. Specify the time in the HH:mm Z format. The time must be in UTC. For example, if you want the… |

### Creates a Tair VNode virtual node instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-tair-kvcache-vnode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Specifies the region where you want to create the instance |
| ZoneId | string | yes | The zone ID. Specifies the zone where you want to create the instance |
| InstanceName | string | no | The name of the new instance. The name must be 2 to 80 characters in length and start with a letter or a Chinese character. It cannot… |
| InstanceClass | string | yes | The instance type |
| ComputeUnitNum | integer | yes | The number of compute units. Currently, only one compute unit is supported |
| VkName | string | yes | The instance ID of the VCluster virtual cluster where the VNode resides |
| VSwitchId | string | yes | The vSwitch ID of the instance. The vSwitch must belong to the VPC of the specified VCluster virtual cluster. You can call the… |
| ChargeType | string | no | The billing method. Valid values: PrePaid: subscription. If you set this parameter to PrePaid, you must also specify the Period parameter |
| Period | integer | no | The subscription period. Unit: months. Valid values: 1 to 9, 12, 24, and 36. This parameter is required when ChargeType is set to PrePaid |
| BusinessInfo | string | no | The extended information such as the campaign ID and business information |
| CouponNo | string | no | The coupon code |
| AutoUseCoupon | string | no | Specifies whether to use a voucher. Valid values: true: uses a voucher. false (default): does not use a voucher |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal. false (default): disables auto-renewal |
| AutoRenewPeriod | string | no | The auto-renewal epoch. Unit: months. Valid values: 1, 2, 3, 6, and 12. This parameter is required when AutoRenew is set to true |
| ResourceGroupId | string | no | The ID of the destination resource group. You can call the https://help.aliyun.com/document_detail/158855.html operation or go to the… |
| AutoPay | string | no | Specifies whether to enable automatic payment. Set the value to true |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| Tag | string | no | The tag information of the instance (JSON-encoded) |
| DryRun | string | no | Specifies whether to perform a dry run on the instance creation operation. Valid values: true: performs a dry run without creating the… |
| VNodeType | string | no | The virtual node type. Valid values: fixed and elastic |
| ElasticTimeRange | string | no | The ElasticTimeRange |

### Creates a Tair Serverless KV table instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-tair-skv-ddb-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value. Make sure that the… |
| RegionId | string | yes | The region ID. You can call DescribeRegions (https://help.aliyun.com/document_detail/61012.htm) to query available regions. Use this… |
| WorkspaceId | string | yes | The ID of the workspace instance. You can call DescribeInstances… |
| TableName | string | yes | The table name. The name must be 2 to 128 characters in length and must start with an uppercase letter, a lowercase letter, or a Chinese… |
| InstanceType | string | yes | The instance type. Set the value to tair_skv_ddb_table |
| SrcDBInstanceId | string | no | To create an instance from a backup set of an existing instance, specify the ID of the source instance in this parameter. This parameter… |
| BackupId | string | no | The cluster backup set ID. Some new cluster architectures support this parameter. You can call DescribeClusterBackupList… |
| RestoreTime | string | no | The RestoreTime |
| Schema | string | no | The table schema configuration in JSON format |
| TtlSpec | string | no | The parameter settings switch in JSON format |

### Creates a Tair Serverless KV workspace instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/create-tair-skv-ddb-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/473763.html operation to query the most recent region list. Use… |
| ZoneId | string | yes | The zone ID. You can call the https://help.aliyun.com/document_detail/473764.html operation to query the most recent zone list |
| InstanceType | string | yes | The instance type. Set the value to tair_skv_ddb_ws |
| InstanceName | string | no | The instance name. The name must be 2 to 128 characters in length and start with a letter or a Chinese character. It cannot contain spaces… |
| Password | string | no | The instance password. The password must meet the following requirements: The password must be 8 to 32 characters in length. The password… |
| VpcId | string | yes | The ID of the virtual private cloud (VPC) |
| VSwitchId | string | yes | The ID of the vSwitch |
| Port | integer | no | The service port of the instance. Valid values: 1 to 65535. Default value: 443 |
| ResourceGroupId | string | no | The ID of the resource group |

### Deletes an account of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/delete-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| AccountName | string | yes | The account name. You can call https://help.aliyun.com/document_detail/473816.html to query the account name |
| SourceBiz | string | no | This parameter is used only for internal maintenance. You do not need to specify this parameter |

### Deletes a specified backup set. Only manual backup sets can be deleted
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/delete-backup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| BackupId | string | yes | The ID of the backup file for the instance. You can call https://help.aliyun.com/document_detail/473823.html to query the ID |
| InstanceId | string | yes | The ID of the instance. You can call https://help.aliyun.com/document_detail/473778.html to obtain the ID |

### Deletes a global IP address whitelist template
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/delete-global-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| GlobalIgName | string | no | The name of the IP whitelist template. The name must meet the following requirements: The name can contain lowercase letters, digits, and… |
| GlobalSecurityGroupId | string | yes | The ID of the IP whitelist template |
| ResourceGroupId | string | no | The resource group ID |

### Deletes a specified scheduled inspection task configuration. ScheduleId specifies the ID of the scheduling…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/delete-inspection-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| ScheduleId | string | no | The ID of the schedule |
| InstanceId | string | yes | The ID of the AI assistant instance |

### Releases an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the instance that you want to release |
| GlobalInstanceId | string | no | The instance ID of the distributed instance to which the instance that you want to release belongs. This parameter is applicable only to… |

### Deletes a parameter template
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/delete-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| ParameterGroupId | string | yes | The parameter template ID |

### Deletes data shard nodes from a cluster instance. This operation is supported only for cloud-native…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/delete-sharding-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The ID of the data shard node to be deleted. To specify multiple shard node IDs, separate them with commas (,). If both the NodeId and… |
| ShardCount | integer | no | The number of shards to be deleted. The system deletes the specified number of shard nodes starting from the end. For example, if an… |
| ForceTrans | string | no | Specifies whether to enable forced migration. Valid values: false (default): Before the upgrade/downgrade, the system checks the current… |
| EffectiveTime | string | no | The time when the proxy deletion takes effect if proxy nodes are deleted when you delete shards from a cluster instance in proxy mode.… |

### Queries the information about an account in a specified ApsaraDB for Tair (Redis® OSS-Compatible) database…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| AccountName | string | no | The name of the account to query |
| SearchAccountName | string | no | The fuzzy match string for the account name |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Queries the O&M task configuration of an instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-active-operation-maintenance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |

### Queries the details of O&M tasks for an ApsaraDB for Redis (Tair) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-active-operation-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| Region | string | yes | The region ID of the pending event. You can call the https://help.aliyun.com/document_detail/473763.html operation to query the region ID.… |
| TaskType | string | yes | The task type. Valid values: rds_apsaradb_ha: node failover. rds_apsaradb_transfer: instance migration. rds_apsaradb_upgrade: minor engine… |
| IsHistory | integer | no | Specifies whether to return historical tasks. Valid values: 0 (default): Returns current tasks. 1: Returns historical tasks |
| PageSize | integer | no | The maximum number of entries per page. The value must be greater than 10. Default value: 30 |
| PageNumber | integer | no | The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. Default value: 1 |

### Queries the number of O&M tasks for a Tair instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-active-operation-task-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |

### Queries the details of O&M events for an instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| Region | string | no | The region ID of the pending event. You can call the https://help.aliyun.com/document_detail/473763.html operation to query available… |
| TaskType | string | no | The event type of the O&M event. If this parameter is left empty, all types are queried |
| PageSize | integer | no | The number of entries per page. Default value: 25. Maximum value: 100 |
| PageNumber | integer | no | The page number. The value must be greater than 0. Default value: 1 |
| ProductId | string | no | The product name. Valid values: RDS, POLARDB, MongoDB, and Redis. For Redis instances, set this parameter to Redis |
| DbType | string | no | The database type. Set this parameter to redis |
| Status | integer | no | The status of the O&M event. This parameter is used to filter the returned events. Valid values: -1: all events. 3: pending events. 4:… |
| InsName | string | no | The instance name. This parameter is optional. If specified, only one instance name is allowed |
| AllowChange | integer | no | Specifies whether the event time can be modified. Default value: -1. Valid values: -1: all events. 0: returns only O&M events whose time… |
| AllowCancel | integer | no | Specifies whether the event can be canceled. Default value: -1. Valid values: -1: all events. 0: returns only O&M events that cannot be… |
| ChangeLevel | string | no | The change level. Default value: all. Valid values: all: all levels including exception recovery and system O&M. S0: exception recovery.… |

### Queries the audit log configuration of a Tair (Redis® OSS-Compatible) instance, such as whether audit…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-audit-log-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the instance resides. You can call the https://help.aliyun.com/document_detail/473779.html operation to query… |
| InstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/473778.html operation to query the instance ID |

### Queries the audit logs of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-audit-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| NodeId | string | no | The ID of the node in the instance. Specify this parameter to query the monitoring information of a specific node. This parameter is… |
| AccountName | string | no | The name of the account. If you do not specify this parameter, the audit logs of all accounts are queried |
| DatabaseName | string | no | The database in the instance. If you do not specify this parameter, the audit logs of all databases are queried. Valid values: 0 to 255.… |
| QueryKeywords | string | no | The keyword used to query audit logs based on a specific command. By default, the audit logs of all executed commands are queried. You can… |
| HostAddress | string | no | The IP address of the client. If you do not specify this parameter, the audit logs of all IP addresses are queried |
| PageSize | integer | no | The maximum number of entries to return on each page |
| PageNumber | integer | no | The page number of the page to return |
| StartTime | string | yes | The start time of the query. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format. The time must be in UTC |
| EndTime | string | yes | The end time of the query. The end time must be later than the start time. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format. The… |

### Queries the instance types available for creation in a specified zone
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-available-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/473763.html operation to query the region ID |
| ZoneId | string | no | The zone ID. You can call the https://help.aliyun.com/document_detail/473764.html operation to query the zone ID |
| InstanceChargeType | string | no | The billing method. Valid values: PrePaid (default): subscription PostPaid: pay-as-you-go |
| OrderType | string | no | The order type. Valid values: BUY (default): new purchase UPGRADE: upgrade instance type DOWNGRADE: downgrade instance type |
| Engine | string | no | The engine type. Valid values: Redis: Redis engine Memcache: Memcache engine |
| ResourceGroupId | string | no | The resource group ID. You can invoke the https://help.aliyun.com/document_detail/158855.html operation to obtain the resource group ID.… |
| InstanceId | string | no | The instance ID. This parameter is available and required only when OrderType is set to UPGRADE or DOWNGRADE |
| AcceptLanguage | string | no | The language of the response. Valid values: zh-CN: Chinese. This is the default value. en-US: English |
| ProductType | string | no | The product type. Valid values: Local (default): Redis Community Edition instance (classic architecture) or memory-optimized instance… |
| NodeId | string | no | The data node ID. You can call the https://help.aliyun.com/document_detail/473786.html operation to obtain the data node ID. For the… |
| InstanceScene | string | no | The product series. Valid values: professional: Professional Edition. This edition supports the standalone, primary/secondary, read/write… |

### Queries the backup policy of an ApsaraDB Tair (Redis® OSS-Compatible) database instance, including the…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries the execution status of backup tasks for a Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-backup-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/473778.html operation to obtain the instance ID |
| BackupJobId | string | no | The ID of the backup task. If you called the https://help.aliyun.com/document_detail/473819.html operation to perform a manual backup, you… |
| JobMode | string | no | The backup mode. Valid values: Automated: automated backup. You can call the https://help.aliyun.com/document_detail/473822.html operation… |

### Queries the backup file information of an ApsaraDB for Tair (compatible with Redis) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-backups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| BackupId | integer | no | The ID of the backup file |
| BackupJobId | integer | no | The ID of the backup task. This ID is returned by the CreateBackup operation. If the CreateBackup operation returns multiple BackupJobIds,… |
| PageSize | integer | no | The maximum number of entries per page. Valid values: 30, 50, 100, 200, and 300 |
| PageNumber | integer | no | The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. Default value: 1 |
| StartTime | string | yes | The start time of the query. Specify the time in the yyyy-MM-dd T HH:mm Z format. The time must be in UTC |
| EndTime | string | yes | The end time of the query. The end time must be later than the start time. Specify the time in the yyyy-MM-dd T HH:mm Z format. The time… |
| NeedAof | string | no | Specifies whether to enable AOF persistence. Valid values: 0: disabled. 1: enabled. Default value: 0 |

### Retrieves the cache analysis report for an instance on a specified date
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-cache-analysis-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Date | string | yes | The date to query. You can query the offline full key analysis results for one day at a time. The format is yyyy-MM-dd Z (UTC time) |
| AnalysisType | string | yes | The analysis type. Set the value to BigKey |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30 |
| PageNumbers | integer | no | The number of the page to return. If the value is greater than the maximum number of pages in the returned result, the returned big key… |
| NodeId | string | no | The ID of the child node in a cluster instance. This parameter is required for cluster instances |

### Queries the list of cache analysis reports of an instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-cache-analysis-report-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Days | integer | no | The number of days within which analysis results are queried. By default, analysis results of the last 7 days are queried. If the… |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30 |
| PageNumbers | integer | no | The page number to return |
| NodeId | string | no | The child node ID of a cluster instance. If you do not specify this parameter, the analysis results of all child nodes are returned |

### Queries the backup list of an ApsaraDB for Tair (Redis-compatible) database cluster instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-cluster-backup-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/473763.html operation to query the region ID |
| InstanceId | string | yes | The instance ID |
| ClusterBackupId | string | no | The cluster backup set ID |
| PageSize | integer | no | The number of entries to return on each page |
| PageNumber | integer | no | The current page number |
| StartTime | string | yes | The start time of the query. Specify the time in the yyyy-MM-dd T HH:mm Z format. The time must be in UTC |
| EndTime | string | yes | The end time of the query. The end time must be later than the start time. Specify the time in the yyyy-MM-dd T HH:mm Z format. The time… |
| NoShardBackup | string | no | Specifies whether to display the details of the backup sets for cluster nodes. Valid values: false (default): displays the backup set… |

### Queries the node configuration information of a Tair (Redis® OSS-Compatible) cluster instance, such as…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-cluster-member-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/473778.html operation to obtain the instance ID |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The maximum number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30 |

### Queries the monitoring collection granularity of a Tair instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-dbinstance-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |

### Queries the network information of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-dbinstance-net-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NetType | string | no | The NetType |

### Queries the virtual IP address (VIP) information of the child instances of a cluster instance in direct…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-dbnode-direct-vip-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. Only cloud-native instances are supported |

### Checks the connectivity from a source client IP address to an instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-db-instance-connectivity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| SrcIp | string | yes | The source IP address of the user |

### Queries the information about ApsaraDB for Tair (Redis-compatible) database instances in a dedicated cluster
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-dedicated-cluster-instance-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/473763.html to query region IDs |
| ZoneId | string | no | The zone ID. You can call https://help.aliyun.com/document_detail/473764.html to query zone IDs |
| InstanceId | string | no | The instance ID. The instance must be created in a dedicated cluster. For more information, see… |
| InstanceStatus | integer | no | The instance status. Valid values: 0: Creating. 1: Running. 3: Deleting. 5: Changing specifications. 6: Migrating. 7: Restoring from… |
| InstanceNetType | string | no | The network type of the instance endpoint. Valid values: 0: Internet. 1: Classic network. 2: Virtual Private Cloud (VPC) |
| Engine | string | no | The database engine. Set the value to Redis |
| EngineVersion | string | no | The database engine version. Set the value to 5.0 |
| ClusterId | string | no | The dedicated cluster ID. You can obtain the ID on the dedicated cluster information page in the ApsaraDB for MyBase console. To specify… |
| DedicatedHostName | string | no | The host ID in the dedicated cluster. You can call https://help.aliyun.com/document_detail/200944.html to query the host ID. To specify… |
| PageNumber | integer | no | The page number. The value must be greater than 0 and less than or equal to the maximum value of the Integer data type. Default value: 1 |
| PageSize | integer | no | The maximum number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30 |

### Queries the details of a custom Transparent Data Encryption (TDE) key for an ApsaraDB for Redis (Tair)…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-encryption-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/473778.html to query the instance ID |
| EncryptionKey | string | no | The ID of the custom key for the instance. You can call https://help.aliyun.com/document_detail/473860.html to query the key ID |

### Queries the list of custom keys used by an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-encryption-key-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/473778.html to query the instance ID |

### Queries the major and minor version information of a Tair (Redis® OSS-Compatible) database instance, as well…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-engine-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the instance. You can call the https://help.aliyun.com/document_detail/473778.html operation to query instance ID |

### Queries the details of a distributed instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-global-distribute-cache` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| GlobalInstanceId | string | no | The distributed instance ID |
| PageNumber | string | no | The page number. Set the value to a number that is greater than 0 and does not exceed the maximum value of the Integer data type. Default… |
| PageSize | string | no | The number of entries per page |
| SubInstanceId | string | no | The child instance ID |

### Queries global IP whitelist templates
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-global-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The ID of the resource group |
| RegionId | string | yes | The region ID |
| GlobalSecurityGroupId | string | no | The ID of the IP whitelist template |
| Engine | string | no | The database engine type. Valid values: redis (Redis engine) and memcache (Memcache engine) |

### Queries the information about global IP whitelist templates associated with an instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-global-security-ipgroup-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| DBClusterId | string | yes | The instance ID |
| ResourceGroupId | string | no | The resource group ID |

### Queries historical events in Event Center
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-history-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/473763.html operation to query the region ID |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10 |
| PageNumber | integer | no | The page number. The value must be greater than 0 and less than or equal to the maximum integer value. Default value: 1 |
| ArchiveStatus | string | no | The archive status of the event. Valid values: Archived: The event is archived. UnArchived: The event is not archived. All: All events |
| EventCategory | string | no | The category of the system event. Valid values: Exception: Exception events. Optimize: Optimization events. Notification: Notification… |
| EventType | string | no | The type of the system event. The EventType parameter is valid only when the InstanceEventType.N parameter is not specified. Valid values:… |
| EventLevel | string | no | The event level. Valid values: INFO: Information. WARN: Warning. CRITICAL: Critical |
| EventStatus | string | no | The status of the event. Valid values: Inquiring: Inquiring. Scheduled: Scheduled. Running: Running. Succeed: Succeeded. Failed: Failed.… |
| ResourceType | string | no | The type of the resource. Valid values: Instance: Instance resources. Host: Host resources. User: User resources. If you do not specify… |
| InstanceId | string | no | The instance ID |
| EventId | string | no | The ID of the event |
| TaskId | string | no | The ID of the task |
| FromStartTime | string | no | The earliest start time of the query task. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC |
| ToStartTime | string | no | The latest start time of the query task. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC and later than the… |
| ResourceGroupId | string | no | The ID of the resource group |

### Queries historical event statistics
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-history-events-stat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ArchiveStatus | string | no | The event status. Valid values: Archived: Archived. UnArchived: Not archived. All: All events |
| FromStartTime | string | no | The beginning of the time range for the task start time. Only tasks whose start time is later than this time are queried. Specify the time… |
| ToStartTime | string | no | The end of the time range for the task start time. Only tasks whose start time is earlier than this time are queried. Specify the time in… |

### Queries the performance monitoring information of a Tair (Redis® OSS-Compatible) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-history-monitor-values` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| StartTime | string | yes | The start time of the query for historical monitoring data. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format (UTC) |
| EndTime | string | yes | The end time of the query for historical monitoring data. The end time must be later than the start time. Specify the time in the… |
| IntervalForHistory | string | yes | [Deprecated] This parameter is deprecated. The value is fixed to `01m`. The system automatically determines the query interval based on… |
| MonitorKeys | string | no | The monitoring metrics. To specify multiple monitoring metrics, separate them with commas (,). Take CpuUsage as an example: Cluster or… |
| NodeId | string | no | The node ID of the instance. Specify this parameter to query the monitoring information of a specific node. This parameter is available… |
| NodeRole | string | no | To query the metrics of a read-only node in a cloud-native read/write splitting instance, specify the NodeId parameter and set this… |
| Type | string | no | The Type |

### Queries the task list in the task center
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-history-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the pending event. You can call https://help.aliyun.com/document_detail/473763.html to query the region ID |
| PageSize | integer | no | The number of entries per page. Valid values: 10 to 100. Default value: 10 |
| PageNumber | integer | no | The page number of the query results. Valid values: positive integers. Default value: 1 |
| InstanceType | string | no | Currently fixed as Instance |
| Status | string | no | The task status. This parameter is used to filter tasks by status. Valid values: Scheduled: Waiting for execution. Running: Running.… |
| InstanceId | string | no | The instance ID. This parameter is used to query tasks for the specified instance. The default value is empty, which indicates no… |
| TaskId | string | no | The task ID. This parameter is used to query tasks with known IDs. The default value is empty, which indicates no restriction. To specify… |
| TaskType | string | no | The task type. This parameter is used to query tasks of a specific type. The default value is empty, which indicates no restriction. Valid… |
| FromStartTime | string | yes | The earliest start time for querying tasks. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC). You can query data from up to 30… |
| ToStartTime | string | yes | The latest start time for querying tasks. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC). The value must be later than the… |
| FromExecTime | integer | no | The minimum execution duration. This parameter is used to filter tasks whose execution duration is greater than the specified value. Unit:… |
| ToExecTime | integer | no | The maximum execution duration. This parameter is used to filter tasks whose execution duration is not less than the specified value.… |

### Queries task statistics in the task center
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-history-tasks-stat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the pending event. You can call the DescribeRegions operation to query the most recent region list |
| Status | string | no | The task status. This parameter is used to filter tasks by status. Valid values: Scheduled: Waiting to be executed. Running: Running.… |
| InstanceId | string | no | The instance ID |
| TaskId | string | no | The task ID. This parameter is used to query a task with a known ID. By default, this parameter is empty, which indicates no restriction.… |
| TaskType | string | no | The task type |
| FromStartTime | string | yes | The beginning of the query time range. Specify the time in the yyyy-mm-dd t hh:mm z format (UTC) |
| ToStartTime | string | yes | The end of the query time range. Specify the time in the yyyy-mm-dd t hh:mm z format (UTC) |
| FromExecTime | integer | no | The minimum execution duration used to filter tasks whose execution duration is greater than this value. Unit: seconds. Default value: 0,… |
| ToExecTime | integer | no | The maximum execution duration used to filter tasks whose execution duration is not less than this value. Unit: seconds. Default value: 0,… |

### Queries the historical inspection reports for timed scheduling
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-inspection-schedule-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| ScheduleId | string | no | The ID of the timed scheduling |
| PageNum | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page |
| InstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/473778.html operation to query the instance ID |
| LevelSummary | string | no | The summary of risk levels for inspection results. You can specify multiple values. Valid values: Normal: Normal. Warning: Warning. Error:… |

### Queries the configurations of scheduled inspection tasks
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-inspection-schedules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| Enabled | integer | no | Specifies whether the scheduled task is enabled |
| PageNum | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| InstanceId | string | yes | The instance ID of the assistant |
| ScheduleId | string | no | The ID of the timed scheduling |

### Queries the report of a specific inspection task
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-inspection-task-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| TaskId | string | yes | The task ID |
| InstanceId | string | yes | The assistant instance ID |
| InspectionInsId | string | no | The ID of the inspection instance |
| LevelSummary | string | no | The summary of risk levels in the inspection results. You can specify multiple values. Valid values: Normal: Normal. Warning: Warning.… |

### Queries the list of intelligent inspection tasks
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-inspection-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| PageNum | string | no | The page number |
| PageSize | string | no | The number of entries per page. Default value: 20 |
| InstanceId | string | yes | The ID of the assistant instance |
| Type | string | no | The task type. Valid values: 1: manual task 2: scheduled task |
| LevelSummary | string | no | The summary of risk levels for inspection results. You can specify multiple values. Valid values: Normal: normal Warning: warning Error:… |

### Queries the details of an ApsaraDB Tair (Redis-compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-instance-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries whether auto-renewal is enabled for a Tair (Redis® OSS-Compatible) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-instance-auto-renewal-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotency of the request. You can use the client to generate the token, but you must make… |
| RegionId | string | yes | The region ID of the instance |
| DBInstanceId | string | no | The ID of the instance. By default, the system queries whether enable auto-renewal is configured for all instances |
| PageSize | integer | no | The number of entries per page. Valid values: 30, 50, and 100. Default value: 30 |
| PageNumber | integer | no | The page number. The value must be greater than 0 and cannot exceed the maximum value of Integer. Default value: 1 |

### Queries some default configuration parameters of a Tair (Redis® OSS-Compatible) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-instance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/473778.html to query the instance ID |

### Queries the load balancer (LB) information of an instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-instance-multi-vip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries whether TLS (SSL) encryption authentication is enabled for a Tair (Redis® OSS-Compatible) database…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-instance-ssl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries whether the TDE data encryption feature is enabled for an ApsaraDB for Tair (Redis® OSS-Compatible)…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-instance-tdestatus` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/473778.html to query the instance ID |

### Queries the information of one or more Tair (Redis® OSS-Compatible) instances
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the instance. When you call this operation, if the Tag parameter is specified, this parameter is required |
| InstanceIds | string | no | The IDs of the instances to be queried. To specify multiple instance IDs, separate the IDs with commas (,). You can specify up to 30… |
| InstanceStatus | string | no | The status of the instance. Valid values: Normal: normal Creating: creating Changing: changing Inactive: disabled Flushing: purge in… |
| ChargeType | string | no | The billing method. Valid values: PrePaid: subscription PostPaid: pay-as-you-go |
| NetworkType | string | no | The network type. Valid values: CLASSIC: classic network VPC: VPC |
| EngineVersion | string | no | The Redis-compatible engine version of the instance. Valid values: 2.8, 4.0, 5.0, 6.0, and 7.0 |
| InstanceClass | string | no | The instance specifications. For more information, see https://help.aliyun.com/document_detail/107984.html |
| VpcId | string | no | The VPC ID |
| VSwitchId | string | no | The vSwitch ID |
| PageNumber | integer | no | The page number of the instance list. Pages start from 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Maximum value: 50. Default value: 30 |
| InstanceType | string | no | The instance type. Valid values: Tair: Tair (Enterprise Edition) Redis: open-source Redis Memcache: Memcache |
| SearchKey | string | no | The search keyword. Fuzzy match is supported for instance names and instance IDs |
| ArchitectureType | string | no | The architecture type. Valid values: cluster: cluster edition standard: standard edition rwsplit: read/write splitting edition |
| Expired | string | no | The expiration status of the instance. Valid values: true: The instance has expired. false: The instance has not expired |
| ZoneId | string | no | The zone ID |
| ResourceGroupId | string | no | The resource group ID. You can invoke the https://help.aliyun.com/document_detail/158855.html operation or use the console to obtain the… |
| GlobalInstance | string | no | Specifies whether to filter child instances of distributed instances in the returned instance list. Valid values: true: Only child… |
| EditionType | string | no | The edition type of the instance. Valid values: Community: open-source Redis Enterprise: Tair Enterprise Edition |
| PrivateIp | string | no | The private IP address in the VPC |
| Tag | string | no | The tag information of the instance (JSON-encoded) |
| NodeType | string | no | The node type. Valid values: MASTER_SLAVE: high-availability (dual-replica) STAND_ALONE: single-replica double: dual-replica single:… |

### Queries the overview information of one or more ApsaraDB for Tair (Redis® OSS-Compatible) database instances
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-instances-overview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the instance. You can call the https://help.aliyun.com/document_detail/473763.html operation to query the region ID |
| InstanceIds | string | no | The IDs of the instances that you want to query. By default, all instances under the current account are queried. To specify multiple… |
| InstanceStatus | string | no | The instance status. Valid values: Normal: The instance is running. Creating: The instance is being created. Changing: The instance is… |
| ChargeType | string | no | The billing method. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go |
| NetworkType | string | no | The network type. Valid values: CLASSIC: classic network. VPC: virtual private cloud (VPC) |
| EngineVersion | string | no | The Redis-compatible engine version of the instance. Valid values: 2.8, 4.0, 5.0, 6.0, and 7.0 |
| InstanceClass | string | no | The instance type. For more information, see https://help.aliyun.com/document_detail/107984.html |
| VpcId | string | no | The VPC ID |
| VSwitchId | string | no | The vSwitch ID |
| InstanceType | string | no | The instance type. Valid values: Tair Redis Memcache |
| SearchKey | string | no | The keyword used for fuzzy search by instance ID or instance description |
| ArchitectureType | string | no | The architecture type. Valid values: cluster: Cluster Edition. standard: Standard Edition. rwsplit: read/write splitting Edition |
| ZoneId | string | no | The zone ID |
| ResourceGroupId | string | no | The resource group ID. You can invoke the https://help.aliyun.com/document_detail/158855.html operation or use the console to obtain the… |
| EditionType | string | no | The edition type. Valid values: Community: Community Edition. Enterprise: Enterprise Edition |
| PrivateIp | string | no | The private IP address |
| NodeType | string | no | The NodeType |

### Queries the current bandwidth of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-intranet-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ResourceGroupId | string | no | The resource group ID |

### Queries the logical topology structure of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-logic-instance-topology` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries the list of monitoring items supported by a Tair (Redis® OSS-Compatible) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-monitor-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |

### Queries the basic information about a query parameter template
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-parameter-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| ParameterGroupId | string | yes | The parameter template ID |

### Queries the list of parameters that can be configured in parameter templates of different versions
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-parameter-group-support-param` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| Category | string | no | The product category. Valid values: standard: ApsaraDB for Redis Community Edition. enterprise: Tair (Redis Enterprise Edition) |
| EngineVersion | string | yes | The compatible version. Valid values: ApsaraDB for Redis Community Edition supports 5.0, 6.0, and 7.0. Tair memory-optimized instances are… |
| EngineType | string | no | The engine type. Valid values: redis: ApsaraDB for Redis Community Edition or Tair memory-optimized instances. tair_pena: Tair persistent… |

### Queries the details of configurable query parameters in a parameter template, such as default values, value…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-parameter-group-template-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| Category | string | yes | The product category. Valid values: standard: Redis Community Edition. enterprise: Tair (Enhanced Edition) |
| EngineVersion | string | yes | The compatible version. Valid values: Redis Community Edition supports 5.0, 6.0, and 7.0. Tair memory-optimized instances are compatible… |
| EngineType | string | yes | The engine type. Valid values: redis: Redis Community Edition or Tair memory-optimized. tair_pena: Tair persistent memory-optimized.… |
| CharacterType | string | no | The role type of the instance. Valid values: logic: cluster logical instance. db: cluster DB instance. proxy: cluster proxy instance. cs:… |

### Queries available parameter templates
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-parameter-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/473763.html to query the region ID |
| DbType | string | no | The engine type. Valid values: redis: open-source Redis or Tair (memory-optimized). tair_pena: Tair (persistent memory-optimized).… |
| EngineVersion | string | no | The compatible engine version |

### Queries the parameter modification history of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-parameter-modification-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/473778.html operation to query the instance ID |
| NodeId | string | no | The node ID. Specify this parameter to query the parameter settings of a specific node in a cluster instance |
| StartTime | string | yes | The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC) |
| EndTime | string | yes | The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format… |
| ParameterName | string | no | The parameter name |

### Queries the parameters and default values of ApsaraDB Tair (Redis® OSS-Compatible) database instances across…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-parameter-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| CharacterType | string | yes | The architecture of the instance. For more information, see https://help.aliyun.com/document_detail/86132.html. Valid values: logic:… |
| Engine | string | yes | The database engine. Set the value to Redis |
| EngineVersion | string | yes | The major engine version of the instance. Valid values: 4.0, 5.0, 6.0, and 7.0 |
| ResourceGroupId | string | no | The ID of the resource group. You can invoke the https://help.aliyun.com/document_detail/158855.html operation to query the ID of the… |
| InstanceId | string | no | The ID of the instance. You can call the https://help.aliyun.com/document_detail/473778.html operation to query the instance ID |
| ParameterCategory | string | no | Specifies whether to query the account parameter template. Set the value to account |

### Queries the configuration parameters and running parameters of a Tair (Redis® OSS-Compatible) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call https://help.aliyun.com/document_detail/473763.html to query available regions. Use this parameter to specify… |
| DBInstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. Specify this parameter to query the parameter settings of a specific node in a cluster instance |

### Queries the fees generated by operations such as creating a Tair (Redis® OSS-Compatible) database instance,…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. You can call https://help.aliyun.com/document_detail/473763.html to query available regions |
| Capacity | integer | no | The storage capacity used to specify the instance type, in MB. This parameter is used only to query Redis Community Edition instances in… |
| InstanceClass | string | no | The instance type specified by using the InstanceClass code. To find the InstanceClass code: In the… |
| OrderType | string | yes | The order type. Valid values: BUY: new purchase. UPGRADE: configuration change. RENEW: renewal. CONVERT: billing method conversion |
| ZoneId | string | no | The zone ID. You can call https://help.aliyun.com/document_detail/473764.html to query available zones |
| SecondaryZoneId | string | no | The secondary zone ID. You can call https://help.aliyun.com/document_detail/473764.html to query available zones. The value of this… |
| ChargeType | string | no | The billing method. Valid values: PostPaid (default): pay-as-you-go. PrePaid: subscription |
| NodeType | string | no | The node type. Valid values: STAND_ALONE: standalone (single replica). MASTER_SLAVE (default): high availability (dual replicas) |
| Period | integer | no | The subscription duration, in months. Valid values: 1 to 9, 12, 24, and 36 |
| Quantity | integer | no | The number of instances to purchase. Valid values: 1 to 30. Default value: 1 |
| InstanceId | string | no | The instance ID. This parameter is required when OrderType is set to UPGRADE or RENEW |
| Instances | string | no | If you want to query the price of cloud-native read/write splitting architecture instances, Tair ESSD-based instances, or multiple… |
| BusinessInfo | string | no | The extended information such as the promotional event ID and business information |
| CouponNo | string | no | The coupon code. Default value: youhuiquan_promotion_option_id_for_blank, which indicates that no coupon code is used |
| ForceUpgrade | string | no | Specifies whether to forcibly change the configuration. Valid values: false: yes. true (default): no |
| OrderParamOut | string | no | Specifies whether to return order parameters. Valid values: false (default): does not return order parameters. true: returns order… |
| ShardCount | integer | no | The number of data shard nodes in a cloud-native cluster instance |
| EngineVersion | string | no | Database engine version of the Redis instance. Valid values: 2.8, 4.0, 5.0, and 6.0. Database engine version of the Redis instance. Valid… |

### Queries all regions and their corresponding active zones supported by ApsaraDB for Tair (Redis®…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| AcceptLanguage | string | no | The language of the value returned for the LocalName parameter. Valid values: zh-CN: Chinese. en-US: English. Default value: zh-CN |

### Queries the roles, types, minor versions, and zones of nodes in a Tair (Redis® OSS-Compatible) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-role-zone-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance. You can call the https://help.aliyun.com/document_detail/473778.html operation to obtain the instance ID |
| QueryType | integer | no | The type of the target node to query. Valid values: 0: proxy node. This parameter is supported only by instances that use the cluster or… |
| PageNumber | integer | no | The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Valid values: 10, 20, and 50. Default value: 10 |

### Queries the running logs of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-running-log-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The ID of the node in the instance. Specify this parameter to query the running logs of a specific node. This parameter is available only… |
| StartTime | string | yes | The start time of the query. You can view the running logs generated within the last 72 hours. Specify the time in the yyyy-MM-dd T HH:mm… |
| EndTime | string | yes | The end time of the query. The end time must be later than the start time, and the time span between the start time and end time cannot… |
| DBName | string | no | The name of the database |
| RoleType | string | no | The role type of the data shard. Valid values: master (default): primary node slave: secondary node |
| PageSize | integer | no | The maximum number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30 |
| PageNumber | integer | no | The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. Default value: 1 |
| ResourceGroupId | string | no | The ID of the resource group |
| CharacterType | string | no | The shard type of the cluster instance. Valid values: proxy: proxy node db: data node cs: config server node If you specify this… |
| QueryKeyword | string | no | The keyword used to query the running logs |
| OrderType | string | no | The sort order of the query results. Valid values: asc: ascending order desc: descending order |

### Queries the security groups in the Settings of the whitelist for an ApsaraDB for Tair (Redis®…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-security-group-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries the IP address whitelist of a Tair (Redis® OSS-Compatible) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-security-ips` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries whether the service-linked role has been authorized for Tair (Redis® OSS-Compatible)
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-service-linked-role-exists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance. This parameter does not affect the query result. You can specify any region |
| Engine | string | no | The database type. You can only set this parameter to "Redis" or leave it empty |

### Queries the slow query logs generated by a Tair (Redis® OSS-Compatible) database instance within a specified…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-slow-log-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID in the instance. Specify this parameter to query the slow query logs of a specific node. This parameter is available only when… |
| StartTime | string | yes | The start time of the query. Specify the time in the yyyy-MM-dd T HH:mm Z format. The time must be in UTC |
| EndTime | string | yes | The end time of the query. The end time must be later than the start time, and the time range cannot exceed 1 day. The recommended time… |
| DBName | string | no | The database name |
| PageSize | integer | no | The maximum number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30 |
| PageNumber | integer | no | The page number. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: 1 |
| SlowLogRecordType | string | no | The slow log type. Valid values: proxy: Slow query logs on proxy nodes. db: Slow query logs on data nodes. This is the default value |
| QueryKeyword | string | no | The keyword used to search the returned results |
| OrderType | string | no | The sort order of the returned results. Valid values: ASC: ascending order. DESC: descending order. This is the default value |
| OrderBy | string | no | The field based on which the returned results are sorted. Valid values: execution_time: sorts the results based on the start time of… |

### Queries all tags in the specified region
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ResourceType | string | no | The resource type. Valid values: INSTANCE and instance |
| NextToken | string | no | The token used to start the next query to return more results. You do not need to provide this parameter for the first query. If a single… |

### Queries the details of one or more Tair KVCache instances
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-tair-kvcache-infer-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| InstanceIds | string | no | The IDs of the instances to query. If you specify multiple instance IDs, separate them with commas (,). You can specify up to 30 instance… |
| InstanceStatus | string | no | The instance status. Valid values: Normal: Normal. Creating: Creating. For more information about instance statuses, see… |
| ChargeType | string | no | The billing method of the instance. Valid values: PrePaid: Subscription. PostPaid: Pay-as-you-go |
| NetworkType | string | no | The network type. Valid values: VPC: Virtual Private Cloud (VPC). This is the default value |
| InstanceClass | string | no | The instance type |
| VpcId | string | no | The VPC ID |
| VSwitchId | string | no | The vSwitch ID |
| PageNumber | integer | no | The page number of the instance list. Pages start from 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 30 |
| SearchKey | string | no | The search keyword. You can use this parameter to perform a fuzzy search by instance name or instance ID |
| Expired | string | no | The expiration status of the instance. Valid values: true: Expired. false: Not expired |
| ZoneId | string | no | The zone ID |
| ResourceGroupId | string | no | The resource group ID. This parameter can be left empty |
| Tag | string | no | The tags of the instance (JSON-encoded) |
| PrivateIp | string | no | [Deprecated] The private IP address of the VPC |

### Queries all Tair Serverless KV table instances in a specified workspace
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-tair-skv-ddb-table` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance to query |

### Retrieves the table schema and configuration information of a specified instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-tair-skv-ddb-table-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance to query |
| BackupId | string | no | The ID of the backup file |

### Queries the details of a node
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-task-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| TaskId | string | yes | The node ID |
| InstanceId | string | yes | The instance ID |

### Queries the zones supported by Tair (Redis® OSS-Compatible) in a specified region. To query the zones that…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/describe-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| AcceptLanguage | string | no | The language of the zone names in the response. Valid values: zh-CN (default): Chinese. en-US: English |

### Permanently destroys an instance and its data backups from the recycle bin
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/destroy-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the instance to revoke from the recycle bin |

### Adjusts the bandwidth of an ApsaraDB Tair (Redis® OSS-Compatible) instance. Currently, only the…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/enable-additional-bandwidth` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance. You can call https://help.aliyun.com/document_detail/473778.html to obtain the instance ID |
| CouponNo | string | no | The ID of the coupon |
| AutoPay | string | no | Specifies whether to enable automatic payment. Valid values: true: enables automatic payment. This is the default value. Make sure that… |
| NodeId | string | no | The ID of the data shard. You can call https://help.aliyun.com/document_detail/473786.html to obtain the shard ID. Separate multiple shard… |
| Bandwidth | string | no | The bandwidth to be increased, in MB/s. The value must be an integer greater than or equal to 0. The maximum value is six times the… |
| OrderTimeLength | string | no | The subscription duration, in days. Valid values: 1, 2, 3, 7, 14, 30, 60, 90, 180, 365, 730, 1095, and 1825. To continue using the… |
| SourceBiz | string | no | The source of the call. This parameter is used only for internal maintenance and does not need to be specified |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: enables auto-renewal. false: disables auto-renewal. This is the default value |
| AutoRenewPeriod | integer | no | The auto-renewal period, in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, and 60. This parameter is available and required… |
| ChargeType | string | no | The billing method for the additional bandwidth. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go. Currently, only this… |
| BandWidthBurst | string | no | Specifies whether to enable burstable (second-level) elastic bandwidth. After elastic scaling for bandwidth is enabled, burstable… |

### Purges expired keys from a Tair (Redis® OSS-Compatible) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/flush-expire-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| EffectiveTime | string | no | The execution time. Valid values: Immediately: Executes the operation immediately. This is the default value. MaintainTime: Executes the… |

### Flushes all data from an ApsaraDB for Tair (Redis® OSS-Compatible) database instance. The data cannot be…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/flush-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Clears data from a specified database in an ApsaraDB for Tair (Redis® OSS-Compatible) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/flush-instance-for-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/473778.html to query the instance ID |
| DbIndex | integer | yes | The index number of the specified DB. Valid values: 0 to 255 |

### Modifies the permissions of an ApsaraDB for Tair (Redis® OSS-Compatible) database account
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/grant-account-privilege` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance to which the account belongs |
| AccountName | string | yes | The account name. You can call https://help.aliyun.com/document_detail/473816.html to obtain the account name |
| AccountPrivilege | string | yes | The permissions of the account. Valid values: RoleReadOnly: read-only permissions. RoleReadWrite: read and write permissions. This is the… |
| SourceBiz | string | no | This parameter is used only for internal maintenance. You do not need to specify this parameter |

### Associates the service-linked role named AliyunServiceRoleForKvstore with Tair (Redis® OSS-Compatible)…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/initialize-kvstore-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |

### Queries the labels you attach to ApsaraDB for Tair (Redis® OSS-Compatible) database instances
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| ResourceType | string | yes | The resource type. Set the value to INSTANCE |
| NextToken | string | no | The token used to start the next query to return more results. You do not need to provide this parameter for the first query. If a query… |
| ResourceId | string | no | The list of instance IDs. You must specify at least one of this parameter and the Tag parameter (JSON-encoded) |
| Tag | string | no | The tag information of the instance. You must specify at least one of this parameter and the ResourceId parameter (JSON-encoded) |

### Locks an instance so that it supports only data reads and does not support writes
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/lock-dbinstance-write` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| LockReason | string | yes | The reason for locking the instance |

### Simulates a failure of a specified data node or proxy node in Tair (Redis® OSS-Compatible). The instance…
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/master-node-shut-down-fail-over` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| FailMode | string | no | Hard: Simulates an unrecoverable hardware failure. A switchover (HA) is directly triggered. Soft (default): Simulates a recoverable… |
| DBNodes | string | no | The specified data nodes |
| ProxyInstanceIds | string | no | The specified proxy nodes |
| ProxyFaultMode | string | no | Specify: Specifies the proxy nodes. Random: The system randomly simulates a failure for one-fourth of the proxy nodes (rounded up to the… |
| DBFaultMode | string | no | Specify: Specifies the data nodes. Random: The system randomly simulates a failure for one-fourth of the data nodes (rounded up to the… |
| InstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/473778.html operation to query the instance ID |
| Category | string | no | The resource type. Set the value to `instance` |

### Migrates an ApsaraDB Tair (Redis OSS-Compatible) instance to another zone in the same region
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/migrate-to-other-zone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| ZoneId | string | yes | The ID of the destination primary zone. You can call the https://help.aliyun.com/document_detail/473764.html operation to query the zone ID |
| VSwitchId | string | no | The vSwitch ID. The zone where the vSwitch resides must be the same as the destination zone specified by ZoneId. This parameter is… |
| EffectiveTime | string | no | The time when the database switchover is performed after data migration. Valid values: Immediately: The switchover is performed… |
| SecondaryZoneId | string | no | The ID of the destination secondary zone. You can call the https://help.aliyun.com/document_detail/473764.html operation to query the zone… |
| ReplicaCount | integer | no | The number of secondary nodes in the primary zone. The ReplicaCount and SlaveReplicaCount parameters apply only to cloud-native instances.… |
| SlaveReplicaCount | integer | no | The number of secondary nodes in the secondary zone |
| ReadOnlyCount | integer | no | The number of read-only nodes in the primary zone. The ReadOnlyCount and SlaveReadOnlyCount parameters apply only to cloud-native… |
| SlaveReadOnlyCount | integer | no | The number of read-only nodes in the secondary zone |

### Modifies the account description of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-account-description` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| AccountName | string | yes | The account name. You can call https://help.aliyun.com/document_detail/473816.html to obtain the account name |
| AccountDescription | string | yes | The account description to set. The description must start with a Chinese character or an English letter and cannot start with `http://`… |
| SourceBiz | string | no | This parameter is used only for internal maintenance. You do not need to specify this parameter |

### Modifies account parameters
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-account-parameter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| AccountName | string | yes | The account name |
| Parameters | string | yes | The account parameters to modify, in JSON format. The modified values overwrite the original values. For example, if you want to modify… |

### Modifies the password of a specified account in a Tair (Redis® OSS-Compatible) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-account-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| AccountName | string | yes | The name of the account whose password you want to modify. You can call https://help.aliyun.com/document_detail/473816.html to query the… |
| OldAccountPassword | string | yes | The original password of the account. If you forget the password of the account, you can call… |
| NewAccountPassword | string | yes | The new password to set for the account. The password must be 8 to 32 characters in length and must contain at least three of the… |
| SourceBiz | string | no | This parameter is used only for internal maintenance purposes. You do not need to specify this parameter |

### Modifies the configuration of an O&M task
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-active-operation-maintain-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| CycleType | string | no | The cycle type. Valid values: Month: Monthly. Week: Weekly |
| CycleTime | string | no | The cycle time. If CycleType is set to Month, the value is a number from 1 to 28, which indicates the day of the month. Multiple values… |
| MaintainStartTime | string | no | The start time of the O&M time window. The time is in the HH:mm:ss Z format (UTC time) |
| MaintainEndTime | string | no | The end time of the O&M time window. The time is in the HH:mm:ssZ format (UTC time) |
| Status | integer | no | Specifies whether the configuration takes effect. Valid values: 1: Effective. 2: Ineffective |

### Modifies the scheduled switchover time of an O&M task
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-active-operation-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| Ids | string | yes | The O&M task IDs, separated by commas (,). You can call https://help.aliyun.com/document_detail/473865.html to obtain the O&M task IDs |
| SwitchTime | string | yes | The scheduled switchover time to set. Specify the time in the yyyy-MM-dd T HH:mm:ss Z format (UTC). The time cannot be later than the… |

### Modifies the switchover time of scheduled O&M events for an instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-active-operation-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| Ids | string | yes | The O&M event IDs. Separate multiple IDs with commas (,) |
| SwitchTime | string | yes | The planned switchover time to set. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC). The time cannot be later than the deadline.… |
| ImmediateStart | integer | no | Specifies whether to immediately start execution scheduling. 0: No. (Default) 1: Yes. If the value is 0, SwitchTime takes effect. If the… |

### Enables or modifies the audit log settings of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-audit-log-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. You can call https://help.aliyun.com/document_detail/473778.html to query the instance ID |
| Retention | integer | no | The number of days for which audit logs are retained. Valid values: 1 to 365. This parameter is required when DbAudit is set to true. This… |
| DbAudit | string | no | Specifies whether to enable audit logging. Valid values: true (default): Enabled. false: Disabled. If the instance uses the… |

### Extends the expiration time of manual backup data
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-backup-expire-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| BackupId | string | no | The backup file ID of the instance. You can call https://help.aliyun.com/document_detail/473823.html to query the ID |
| ExpectExpireTime | string | yes | The point in time to which you want to extend the expiration. Specify the time in the yyyy-MM-ddTHH:mmZ format in UTC. The specified point… |
| InstanceId | string | yes | The instance ID |

### Modifies the automatic backup policy of an ApsaraDB for Tair (Redis® OSS-Compatible) database instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-backup-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| PreferredBackupTime | string | yes | The backup time. Specify the time in the HH:mm Z- HH:mm Z format (UTC). The time must be on the hour, and the interval must be 1 hour |
| PreferredBackupPeriod | string | yes | The backup cycle. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday You can specify multiple values. Separate them… |
| EnableBackupLog | integer | no | Specifies whether to enable the data flashback feature. Valid values: 1: Enabled. Make sure that append-only file (AOF) persistence is… |
| BackupRetentionPeriod | integer | no | The number of days for which data backups are retained. Default value: 7. Valid values: 7 to 730 |

### Modifies the automatic minor engine version update switch for an instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-dbinstance-auto-upgrade` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID. You can call DescribeDBInstances to obtain the instance ID |
| Value | string | yes | The automatic minor engine version update switch. Valid values: 1: Enabled. 0: Disabled |

### Modifies the endpoint and port of a Tair (Redis® OSS-Compatible) instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-dbinstance-connection-string` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| NewConnectionString | string | no | The prefix of the new endpoint. The endpoint of the instance is in the format of ` .redis.rds.aliyuncs.com`. The prefix must start with a… |
| CurrentConnectionString | string | yes | The current endpoint of the instance |
| Port | string | no | The service port number of the instance. Valid values: 1 to 65535. You must specify at least one of the request parameters… |
| IPType | string | no | The network type of the endpoint. Valid values: Private: virtual private cloud (VPC). Public: Internet |

### Modifies the monitoring collection granularity of a Tair instance
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-dbinstance-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| DBInstanceId | string | yes | The ID of the Tair instance. This operation is used only to modify the monitoring collection granularity of a Tair instance |
| Interval | string | yes | [Deprecated] This parameter is deprecated and uses a fixed value of 60. The collection granularity of monitoring data. Unit: seconds.… |

### Modifies event information
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-event-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| EventId | string | yes | The event IDs. Separate multiple IDs with commas. A maximum of 20 IDs are supported |
| EventAction | string | no | The action to process the event. Valid values: archive: Archives the event. undo: Does not process the event |
| ActionParams | string | no | The parameters related to the action in JSON format. When TaskAction is set to modifySwitchTime, set this parameter to `{"recoverMode":… |

### Modifies a global IP address whitelist template
`POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/modify-global-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://r-kvstore.ap-southeast-1.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID |
| RegionId | string | yes | The region ID |
| GlobalIgName | string | yes | The name of the IP whitelist template. The name must meet the following requirements: The name can contain lowercase letters, digits, and… |
| GlobalSecurityGroupId | string | yes | The ID of the IP whitelist template |
| GIpList | string | yes | The IP addresses in the IP whitelist template. This parameter overwrites the original value |

…and 46 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-r-kvstore/add-sharding-node" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Tair (Redis® OSS-Compatible) API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-r-kvstore/add-sharding-node with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Tair (Redis® OSS-Compatible) API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Tair (Redis® OSS-Compatible) itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Tair (Redis® OSS-Compatible) API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-r-kvstore.

### What is the status of the Alibaba Cloud Tair (Redis® OSS-Compatible) API?
Needs your own provider key (bring your own key)