迁移分片请求

迁移数据库分片的 REST API 请求

Redis 企业软件
方法 路径 描述
发布 /v1/shards/actions/migrate 迁移多个分片
发布 /v1/shards/{uid}/actions/migrate 迁移特定分片

迁移多个分片

POST /v1/shards/actions/migrate

将给定分片 UID 的列表迁移到target_node_uid.分片可以来自多个数据库。此请求是异步的。

有关分片迁移使用案例和注意事项的更多信息，请参阅迁移数据库分片。

所需权限

权限名称 角色
migrate_shard admin
cluster_member
db_member

请求

HTTP 请求示例

POST /v1/shards/actions/migrate

示例 JSON 正文

{
  "shard_uids": ["2","4","6"],
  "target_node_uid": 9,
  "override_rack_policy": false,
  "preserve_roles": false,
  "max_concurrent_bdb_migrations": 3
}

Request headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Request body

The request body is a JSON object that can contain the following fields:

Field Type Description
shard_uids array of strings List of shard UIDs to migrate.
target_node_uid integer UID of the node to where the shards should migrate.
override_rack_policy boolean If true, overrides and ignores rack-aware policy violations.
dry_run boolean Determines whether the migration is actually done. If true, will just do a dry run. If the dry run succeeds, the request returns a 200 OK status code. Otherwise, it returns a JSON object with an error code and description.
preserve_roles boolean If true, preserves the migrated shards' roles after migration.
max_concurrent_bdb_migrations integer The number of concurrent databases that can migrate shards.

Response

Returns a JSON object with an action_uid. You can track the action's progress with a GET /v1/actions/<action_uid> request.

Example JSON body

{
    "action_uid": "e5e24ddf-a456-4a7e-ad53-4463cd44880e",
    "description": "Migrate was triggered"
}

Status codes

Code Description
200 OK No error.
400 Bad Request Conflicting parameters.
404 Not Found A list of shard UIDs is required and not given, a specified shard does not exist, or a node UID is required and not given.
500 Internal Server Error Migration failed.

Migrate shard

POST /v1/shards/{int: uid}/actions/migrate

Migrates the shard with the given shard_uid to the node specified by target_node_uid. If the shard is already on the target node, nothing happens. This request is asynchronous.

For more information about shard migration use cases and considerations, see Migrate database shards.

Required permissions

Permission name Roles
migrate_shard admin
cluster_member
db_member

Request

Example HTTP request

POST /v1/shards/1/actions/migrate

Example JSON body

{
    "target_node_uid": 9,
    "override_rack_policy": false,
    "preserve_roles": false
}

Request headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

URL parameters

Field Type Description
uid integer The unique ID of the shard to migrate.

Request body

The request body is a JSON object that can contain the following fields:

Field Type Description
target_node_uid integer UID of the node to where the shard should migrate.
override_rack_policy boolean If true, overrides and ignores rack-aware policy violations.
dry_run boolean Determines whether the migration is actually done. If true, will just do a dry run. If the dry run succeeds, the request returns a 200 OK status code. Otherwise, it returns a JSON object with an error code and description.
preserve_roles boolean If true, preserves the migrated shards' roles after migration.

Response

Returns a JSON object with an action_uid. You can track the action's progress with a GET /v1/actions/<action_uid> request.

Example JSON body

{
    "action_uid": "e5e24ddf-a456-4a7e-ad53-4463cd44880e",
    "description": "Migrate was triggered"
}

Status codes

Code Description
200 OK No error.
404 Not Found Shard does not exist, or node UID is required and not given.
409 Conflict Database is currently busy.
RATE THIS PAGE
Back to top ↑