华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 instance_id String 实例ID。 count Integer 大key分析的次数。 records Array of RecordsResponse objects 大key分析记录列表。 表4 RecordsResponse 参数 参数类型 描述 id String 任务执行记录ID(此ID对应“查询大key/热key分析详情”参数中的任务ID)。 status String 分析任务状态。 枚举值: waiting running success failed scan_type String 分析方式。 枚举值: manual auto created_at String 分析任务创建时间,格式为:"2020-06-15T02:21:18.669Z"。 started_at String 分析任务开始时间,格式为:"2020-06-15T02:21:18.669Z"。 finished_at String 分析任务结束时间,式为:"2020-06-15T02:21:18.669Z"。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信(暂未使用,赋值为null)。 最大长度:1024 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信(暂未使用,赋值为null)。 最大长度:1024 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信(暂未使用,赋值为null)。 最大长度:1024 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信(暂未使用,赋值为null)。 最大长度:1024 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信(暂未使用,赋值为null)。 最大长度:1024
  • URI GET /v2/{project_id}/instances/{instance_id}/bigkey-tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询, offset大于等于0。 limit 否 Integer 每页显示的条目数量。 status 否 String 分析任务状态。 枚举值: waiting running success failed
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度:1024 error_code String 错误码 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null) 最大长度:1024 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度:1024 error_code String 错误码 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null) 最大长度:1024 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度:1024 error_code String 错误码 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null) 最大长度:1024 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度:1024 error_code String 错误码 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null) 最大长度:1024 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度:1024 error_code String 错误码 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null) 最大长度:1024
  • 响应示例 状态码: 200 获取可删除的副本成功。 { "check_result" : true, "available_zone" : "9f1c5806706d4c1fb0eb72f0a9b18c77", "replication_list" : [ { "replication_id" : "435a6322-0c64-4d0e-8bc2-8adefa2eca26", "node_id" : "8abf6e1e7fd3e695017fd4046bb9006b", "replication_ip" : "192.168.73.139:6379", "group_id" : "cbf8deba-d69f-41b8-8556-83337d32ad40", "group_name" : "group-2", "available_zone" : "9f1c5806706d4c1fb0eb72f0a9b18c77" }, { "replication_id" : "193683cf-f693-4a6a-950a-20f615ed6c47", "node_id" : "8abf6e1e7fd3e695017fd4046bb8006a", "replication_ip" : "192.168.67.86:6379", "group_id" : "7a153688-d31d-4541-b635-191885c71e93", "group_name" : "group-1", "available_zone" : "9f1c5806706d4c1fb0eb72f0a9b18c77" }, { "replication_id" : "ae38792f-60b7-4c8c-b1dc-175f2151f85f", "node_id" : "8abf6e1e7fd3e695017fd4046bb40069", "replication_ip" : "192.168.66.157:6379", "group_id" : "4f26a524-1525-4975-82fa-b2291091f9e7", "group_name" : "group-0", "available_zone" : "9f1c5806706d4c1fb0eb72f0a9b18c77" } ] } 状态码: 400 非法请求。 { "error_code" : 111400800, "error_msg" : "Only native cluster supported." } 状态码: 500 内部服务错误。 { "error_code" : 111500024, "error_msg" : "Query instance error." }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 check_result Boolean 是否有可供选择的副本组进行删除。 available_zone String 可选的可用区ID列表。 replication_list Array of ReplicationInfo objects 可选的保留节点列表。 表3 ReplicationInfo 参数 参数类型 描述 replication_id String 副本ID。 node_id String 节点ID。 replication_ip String 副本的IP和端口。 group_id String 分片ID。 group_name String 分片名称。 available_zone String 可用区ID。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 client_id String 客户端ID。 databases Integer DB数量。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024
  • 响应示例 状态码: 200 登录webCli成功。 { "client_id" : "238d8f22ccbc1f497482d5c8c87df023de14ea3eaee55dc8", "databases" : 256 } 状态码: 400 非法请求。 { "error_code" : "111400063", "error_msg" : "Invalid {0} parameter in the request." }
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度:1024 error_code String 错误码 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null) 最大长度:1024 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度:1024 error_code String 错误码 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null) 最大长度:1024 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度:1024 error_code String 错误码 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null) 最大长度:1024 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度:1024 error_code String 错误码 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null) 最大长度:1024 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最大长度:1024 error_code String 错误码 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null) 最大长度:1024
  • 响应参数 状态码: 200 表1 响应Body参数 参数 参数类型 描述 region_id String 区域ID。 available_zones Array of AvailableZones objects 可用分区数组。 表2 AvailableZones 参数 参数类型 描述 code String 可用区编码。 port String 可用区端口号。 name String 可用区名称。 id String 可用区ID。 resource_availability String 分区上是否还有可用资源。 true:还有资源。 false:没有可用资源。 枚举值: true false
  • 响应示例 状态码: 200 查询成功。 { "region_id" : "region00", "available_zones" : [ { "code" : "region01", "port" : "8403", "name" : "可用区1", "id" : "effdcbc7d4d64a02aa1fa26b42f56533", "resource_availability" : "true" }, { "code" : "region02", "port" : "8404", "name" : "可用区2", "id" : "a0865121f83b41cbafce65930a22a6e8", "resource_availability" : "true" }, { "code" : "region03", "port" : "8408", "name" : "可用区3", "id" : "2dcb154ac2724a6d92e9bcc859657c1e", "resource_availability" : "true" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 task_count String 任务个数。 tasks Array of SingleBackgroundTask objects 任务详情数组。 表4 SingleBackgroundTask 参数 参数类型 描述 id String 后台任务ID。 name String 后台任务名,目前支持以下取值: EXTEND:变更规格 BindEip:开启公网访问 UnBindEip:关闭公网访问 AddReplica:添加副本 DelReplica:删除副本 AddWhitelist:设置IP白名单 UpdatePort:修改端口 RemoveIpFromDns:域名摘除IP masterStandbySwapJob: 主备切换任务 modify:修改密码 details DetailsBody object 详细信息。 user_name String 用户名。 user_id String 用户ID。 params String 任务相关参数。 status String 任务状态。 created_at String 任务启动时间,格式为2020-06-17T07:38:42.503Z。 updated_at String 任务结束时间,格式为2020-06-17T07:38:42.503Z。 enable_show Boolean 是否有详细任务进展,可以展开查看。 表5 DetailsBody 参数 参数类型 描述 old_capacity String 变更前的容量,仅在变更规格时有值。 new_capacity String 变更后的容量,仅在变更规格时有值。 enable_public_ip Boolean 是否开启公网访问,仅在开启公网访问时有值。 public_ip_id String 公网IP的ID,仅在开启公网访问时有值。 public_ip_address String 公网IP地址,仅在开启公网访问时有值。 enable_ssl Boolean 是否开启SSL,仅在开启SSL时有值。 old_cache_mode String 变更前的缓存类型,仅在变更规格时有值。 new_cache_mode String 变更后的缓存类型,仅在变更规格时有值。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024
  • 响应示例 状态码: 200 查询后台任务列表成功。 { "task_count" : 1, "tasks" : [ { "id" : "8abf6e1e72c12e7c0172c15b508500aa", "name" : "EXTEND", "user_name" : "paas_dcs_000_02", "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7", "details" : { "old_cache_mode" : "single", "new_cache_mode" : "single", "old_capacity" : "0.125", "new_capacity" : "0.25" }, "enable_show" : false, "status" : "SUCCESS", "created_at" : "2020-06-17T08:18:06.597Z", "updated_at" : "2020-06-17T08:18:10.106Z" } ] }
  • URI GET /v2/{project_id}/instances/{instance_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 limit 否 Integer 每页显示的条目数量。 start_time 否 String 查询开始时间,时间为UTC时间。格式:yyyyMMddHHmmss,如:20200609160000。 end_time 否 String 查询结束时间,时间为UTC时间。格式:yyyyMMddHHmmss,如:20200617155959。
  • URI GET /v2/{project_id}/instances/{instance_id}/operations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 operation 是 String 操作信息。扩容即extend。 枚举值: extend
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 instance_id String 实例ID operations Array of Operations objects 支持的操作列表,目前只支持扩容 表4 Operations 参数 参数类型 描述 operation String 操作信息。 is_support Boolean 是否支持该操作。 cause_id String 不支持该操作的错误原因。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024
  • 响应示例 状态码: 200 查询实例是否可以扩容成功。 { "instance_id" : "dacf949d-7f8a-4244-a4e8-6a4119186ac3", "operations" : [ { "operation" : "extend", "is_support" : true, "cause_id" : null } ] } 状态码: 400 非法请求。 { "error_code" : "111400063", "error_msg" : "Invalid {0} parameter in the request." }
  • 响应示例 状态码: 200 查询实例统计信息成功。 { "statistics" : [ { "output_kbps" : "0.0", "instance_id" : "e008652d-18e0-43ff-924e-072261e0372a", "keys" : 0, "used_memory" : 0, "cmd_get_count" : 0, "used_cpu" : "0.0", "cmd_set_count" : 0, "input_kbps" : "0.0", "max_memory" : 460 }, { "output_kbps" : "0.0", "instance_id" : "c577a1eb-33b7-42c7-8231-ad32358599ac", "keys" : 0, "used_memory" : 0, "cmd_get_count" : 0, "used_cpu" : "0.0", "cmd_set_count" : 0, "input_kbps" : "0.0", "max_memory" : 460 }, { "output_kbps" : "1.19", "instance_id" : "e8b98471-55d5-4695-b0bb-8f336a98e207", "keys" : 0, "used_memory" : 0, "cmd_get_count" : 0, "used_cpu" : "0.0", "cmd_set_count" : 0, "input_kbps" : "0.03", "max_memory" : 460 }, { "output_kbps" : "0.0", "instance_id" : "bc61c690-4b34-4cbe-9ce3-11246aea7aba", "keys" : 0, "used_memory" : 0, "cmd_get_count" : 0, "used_cpu" : "0.0", "cmd_set_count" : 0, "input_kbps" : "0.0", "max_memory" : 6963 } ] }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 statistics Array of InstanceStatistic objects 该租户下处于“运行中”状态的实例的统计信息。 表3 InstanceStatistic 参数 参数类型 描述 input_kbps String 缓存实例网络入流量,单位:kbit/s。 output_kbps String 缓存实例网络出流量,单位:kbit/s。 instance_id String 实例ID。 keys Long 缓存存储的数据条数。 used_memory Long 缓存已经使用内存,单位:MB。 max_memory Long 缓存的总内存,单位:MB。 cmd_get_count Long 缓存get命令被调用次数。 cmd_set_count Long 缓存set命令被调用次数。 used_cpu String 缓存在用户态和核心态消耗cpu时间的累计值,单位:秒。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024
  • 请求示例 创建备份导入迁移任务,备份数据来源于OBS桶。 POST https://{dcs_endpoint}/v2/{project_id}/migration-task { "task_name" : "migration1", "description" : "Test", "migration_type" : "backupfile_import", "migration_method" : "full_amount_migration", "backup_files" : { "bucket_name" : "bucketName", "file_source" : "self_build_obs", "files" : [ { "size" : "754.0MB", "file_name" : "fileName" } ] }, "target_instance" : { "id" : "d2c8399f-bdba-43c1-8069-3ff17a1a79d5", "name" : "dcs-test", "password" : "xxxxxx" } }
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 id String 迁移任务ID。 name String 迁移任务名称。 status String 迁移任务状态,这个字段的值包括:SUCCESS(成功), FAILED(失败), MIGRATING(迁移中),TERMINATED(已结束)。 枚举值: SUCCESS FAILED MIGRATING TERMINATED error String 错误信息。 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 401 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 403 表10 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 404 表11 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 500 表12 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 task_name 是 String 备份导入任务名称。 description 否 String 备份导入任务描述。 migration_type 是 String 迁移任务类型。 取值范围: backupfile_import:表示备份文件导入。 online_migration:表示在线迁移。目前已不支持使用该接口创建在线迁移任务,请调用CreateOnlineMigrationTask创建在线迁移任务。 枚举值: backupfile_import migration_method 是 String 迁移方式,包括全量迁移和增量迁移两种类型。 取值范围: full_amount_migration:表示全量迁移。 incremental_migration:表示增量迁移。 枚举值: full_amount_migration incremental_migration backup_files 否 BackupFilesBody object 迁移任务类型为备份文件导入场景时的备份文件列表。 network_type 否 String 迁移任务类型为在线迁移时,表示源Redis和目标Redis连通的网络类型,包括vpc和vpn两种类型。目前已不支持用该接口创建在线迁移任务,请调用CreateOnlineMigrationTask创建在线迁移任务。 枚举值: vpc vpn source_instance 否 SourceInstanceBody object 迁移任务类型为在线迁移场景时该参数为必填参数,表示源Redis信息。目前已不支持用该接口创建在线迁移任务,请调用CreateOnlineMigrationTask创建在线迁移任务。 target_instance 是 TargetInstanceBody object 表示目标Redis信息。 表3 BackupFilesBody 参数 是否必选 参数类型 描述 file_source 否 String 数据来源,包含OBS桶和备份记录两种类型。 枚举值: self_build_obs backup_record bucket_name 是 String OBS桶名。 files 是 Array of Files objects 导入的备份文件文件列表,数据来源为OBS桶时必须填写。 backup_id 否 String 备份记录ID,数据来源为备份记录时必须填写。 表4 Files 参数 是否必选 参数类型 描述 file_name 是 String 备份文件名。 size 否 String 文件大小(单位:Byte)。 update_at 否 String 文件最后修改时间(格式YYYY-MM-DD HH:MM:SS)。 表5 SourceInstanceBody 参数 是否必选 参数类型 描述 addrs 是 String Redis实例地址(source_instance信息中填写)。 password 否 String Redis密码,如果设置了密码,则必须填写。 表6 TargetInstanceBody 参数 是否必选 参数类型 描述 id 是 String Redis实例ID(target_instance信息中必须填写)。 name 否 String Redis实例名称(target_instance信息中填写)。 password 否 String Redis密码,如果设置了密码,则必须填写。
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 redis_config 否 Array of RedisConfig objects 实例配置项数组。 表3 RedisConfig 参数 是否必选 参数类型 描述 param_value 是 String 实例配置项的值。 param_name 是 String 实例配置项名。 param_id 是 String 实例配置项ID。
  • 请求示例 修改实例配置参数,例如将timeout参数(客户端与服务空闲超时断开的时间)设置为1000秒。 PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/configs { "redis_config" : [ { "param_id" : "1", "param_name" : "timeout", "param_value" : "1000" } ] }
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024
  • 响应参数 状态码: 400 表2 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 401 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 message String 返回消息。 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024
  • 响应参数 状态码: 400 表2 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 401 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 最大长度:1024 error_code String 错误码。 最大长度:9 error_ext_msg String 扩展错误信息(暂未使用,赋值为null)。 最大长度:1024
  • 请求示例 为指定实例批量添加标签。 POST https://{dcs_endpoint}/v2/7dddae81f0e34f62adb9618bc8c8b1fe/dcs/01928d55-7020-4500-9c29-774caabe4bc4/tags/action { "action" : "create", "tags" : [ { "value" : "2", "key" : "dcs001" }, { "value" : "4", "key" : "dcs003" } ] } 为指定实例批量删除标签。 POST https://{dcs_endpoint}/v2/7dddae81f0e34f62adb9618bc8c8b1fe/dcs/01928d55-7020-4500-9c29-774caabe4bc4/tags/action { "action" : "delete", "tags" : [ { "key" : "key1", "value" : "11" } ] }
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识:仅限于create(创建)、delete(删除)。 tags 是 Array of ResourceTag objects 标签列表。 表3 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 标签键。 对于同一资源键值唯一。 长度不超过128个字符。 标签的键必须唯一且输入不能为空。 value 否 String 标签值。 action为create时必选。action为delete时非必选。 长度不超过255个字符。
  • 请求示例 创建一个在线数据迁移任务,配置在线迁移虚拟机资源的VPC、子网和安全组。 POST https://{dcs_endpoint}/v2/{project_id}/migration/instance { "name" : "dcs-migration-thrc", "description" : "创建在线数据迁移任务", "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481", "subnet_id" : "40f15ed6-7f85-49d5-ba0e-65b940d4812c", "security_group_id" : "9df96622-24b7-4813-84b8-ab74552a21d7" }
共100000条