CLI命令参考_CLI参考_分布式缓存服务 DCS-华为云

生命周期管理

API名称	命令	描述	操作
创建缓存实例	hcloud DCS CreateInstance	创建缓存实例，该接口创建的缓存实例支持按需计费和包周期两种方式。	去调试
查询所有实例列表	hcloud DCS ListInstances	查询租户的缓存实例列表，支持按照条件查询。	去调试
批量删除实例	hcloud DCS BatchDeleteInstances	批量删除多个缓存实例。	去调试
查询指定实例	hcloud DCS ShowInstance	通过实例ID查询实例的详细信息。	去调试
删除实例	hcloud DCS DeleteSingleInstance	删除指定的缓存实例，释放该实例的所有资源。	去调试
修改实例信息	hcloud DCS UpdateInstance	修改缓存实例的信息，可修改信息包括实例名称、描述、备份策略、维护时间窗开始和结束时间以及安全组。	去调试
变更实例规格	hcloud DCS ResizeInstance	用户可以为状态为“运行中”的DCS缓存实例进行规格变更，当前仅能支持按需实例的同副本或分片数量的实例规格变更。	去调试
校验集群副本是否支持删除	hcloud DCS ValidateDeletableReplica	校验集群副本是否支持删除。	去调试
包周期实例变更规格	hcloud DCS CreateResizeOrder	包周期实例变更规格。	去调试

实例管理

API名称	命令	描述	操作
主备切换	hcloud DCS ChangeMasterStandby	切换实例主备节点，只有主备实例支持该操作。	去调试
修改密码	hcloud DCS UpdatePassword	修改缓存实例的密码。	去调试
查询实例状态	hcloud DCS ListNumberOfInstancesInDifferentStatus	查询该租户在当前区域下不同状态的实例数。	去调试
重启实例或清空数据	hcloud DCS RestartOrFlushInstances	重启运行中的DCS缓存实例。	去调试
查询运行中实例的统计信息	hcloud DCS ListStatisticsOfRunningInstances	查询当前租户下处于“运行中”状态的缓存实例的统计信息。	去调试
重置密码	hcloud DCS ResetPassword	重置缓存实例的密码。	去调试
变更指定实例的带宽	hcloud DCS UpdateInstanceBandwidth	变更指定实例的带宽。	去调试
集群分片倒换	hcloud DCS ExecuteClusterSwitchover	集群分片倒换，适用于proxy和cluster实例。	去调试
查询实例参数修改记录详情	hcloud DCS ShowConfigHistoryDetail	查询实例参数修改记录详情。	去调试
开启或关闭客户端ip透传	hcloud DCS UpdateClientIpTransparentTransmission	开启或关闭客户端ip透传。	去调试
查询实例是否可以扩容	hcloud DCS ListInstanceOperations	查询实例是否可以扩容。	去调试
异步导出实例资源	hcloud DCS ExportInstancesTask	异步导出实例资源。	去调试
异步交换实例主备节点	hcloud DCS ChangeMasterStandbyAsync	异步交换实例主备节点。	去调试
获取实例分片带宽	hcloud DCS ShowBandwidths	获取实例各个分片带宽。	去调试
修改实例分片带宽	hcloud DCS UpdateBandwidth	修改实例分片带宽。	去调试
查询实例带宽弹性伸缩策略	hcloud DCS ShowInstanceBandwidthAutoScalingPolicy	查询实例带宽弹性伸缩策略。	去调试
更新实例带宽弹性伸缩策略	hcloud DCS UpdateInstanceBandwidthAutoScalingPolicy	更新实例带宽弹性伸缩策略。暂不支持实例带宽自动回缩。	去调试
删除实例带宽弹性伸缩策略	hcloud DCS DeleteInstanceBandwidthAutoScalingPolicy	删除实例带宽弹性伸缩策略。	去调试
开启/修改实例公网访问	hcloud DCS UpdatePublicIp	开启/修改实例公网访问。	去调试
关闭实例公网访问	hcloud DCS DeletePublicIp	关闭实例公网访问。	去调试
指定实例节点启停开关	hcloud DCS ChangeNodesStartStopStatus	实例节点启停。执行节点关机操作前的24小时内，需要对实例（单机实例除外）进行数据备份。	去调试
根据实例ID获取实例内核版本信息	hcloud DCS ShowInstanceVersion	获取对应实例内核版本号。	去调试
升级实例小版本	hcloud DCS UpgradeInstanceMinorVersion	升级实例小版本。	去调试
变更可用区	hcloud DCS MigrateAz	迁移缓存实例可用区，完成单可用区实例跨可用区改造。	去调试
查询集群实例拓扑关系图	hcloud DCS ShowInstanceTopology	查询集群实例拓扑关系图。	去调试

分片与副本

API名称	命令	描述	操作
设置备节点优先级	hcloud DCS UpdateSlavePriority	设置副本优先级，主节点故障时，权重越小的备节点切换为主节点的优先级越高。	去调试
域名摘除IP	hcloud DCS DeleteIpFromDomainName	将只读副本的IP从域名中摘除，摘除成功后，只读域名不会再解析到该副本IP。	去调试
查询分片信息	hcloud DCS ListGroupReplicationInfo	查询读写分离实例和集群实例的分片和副本信息，其中，读写分离实例仅Redis4.0和Redis5.0的主备实例支持。	去调试
批量查询实例节点信息	hcloud DCS BatchShowNodesInformation	批量查询指定项目所有实例的节点信息、有效实例个数及节点个数。	去调试
查询实例节点信息	hcloud DCS ShowNodesInformation	查询指定实例的节点信息。	去调试
获取副本状态	hcloud DCS ShowReplicationStates	获取副本状态。	去调试

参数管理

API名称	命令	描述	操作
查询实例配置参数	hcloud DCS ListConfigurations	查询指定实例的配置参数信息。	去调试
修改实例配置参数	hcloud DCS UpdateConfigurations	为了确保分布式缓存服务发挥出最优性能，您可以根据自己的业务情况对DCS缓存实例的运行参数进行调整。	去调试
查询实例参数修改记录列表	hcloud DCS ListConfigHistories	查询实例的参数修改记录列表，支持按照关键字查询。	去调试
异步修改实例配置参数	hcloud DCS UpdateInstanceConfig	为了确保分布式缓存服务发挥出最优性能，您可以根据自己的业务情况对DCS缓存实例的运行参数进行调整。	去调试

备份与恢复

API名称	命令	描述	操作
删除备份文件	hcloud DCS DeleteBackupFile	删除缓存实例已备份的文件。	去调试
恢复指定实例	hcloud DCS RestoreInstance	恢复指定的缓存实例。	去调试
查询实例恢复记录	hcloud DCS ListRestoreRecords	查询指定缓存实例的恢复记录列表。	去调试
获取备份文件下载链接	hcloud DCS ListBackupFileLinks	获取指定实例的备份文件下载链接，下载备份文件。	去调试
备份指定实例	hcloud DCS CopyInstance	备份指定的缓存实例。	去调试
查询实例备份信息	hcloud DCS ListBackupRecords	查询指定缓存实例的备份信息列表。	去调试

数据迁移

API名称	命令	描述	操作
创建数据迁移任务	hcloud DCS CreateMigrationTask	创建数据迁移任务。	去调试
查询迁移任务列表	hcloud DCS ListMigrationTask	查询迁移任务列表。	去调试
删除数据迁移任务	hcloud DCS DeleteMigrationTask	删除数据迁移任务。	去调试
查询迁移任务详情	hcloud DCS ShowMigrationTask	查询迁移任务详情。	去调试
设置迁移任务自动重连	hcloud DCS UpdateMigrationTask	设置迁移任务自动重连。	去调试
停止数据迁移任务	hcloud DCS StopMigrationTask	停止数据迁移任务。	去调试
查询在线迁移进度明细	hcloud DCS ShowMigrationTaskStats	查询在线迁移进度明细。	去调试
创建在线数据迁移任务	hcloud DCS CreateOnlineMigrationTask	创建在线数据迁移任务。	去调试
配置在线数据迁移任务	hcloud DCS SetOnlineMigrationTask	配置在线数据迁移任务。	去调试
批量停止数据迁移任务	hcloud DCS BatchStopMigrationTasks	批量停止数据迁移任务，接口响应成功，仅表示下发任务成功。查询到迁移任务状态为TERMINATED时，即停止成功。	去调试
同步停止数据迁移任务	hcloud DCS StopMigrationTaskSync	同步停止数据迁移任务。	去调试
查询迁移日志列表	hcloud DCS ListMigrationTaskLogs	查询迁移日志列表。	去调试
进行IP交换	hcloud DCS ExchangeInstanceIp	进行IP交换。	去调试
批量重启在线迁移任务	hcloud DCS BatchRestartOnlineMigrationTasks	批量重启在线迁移任务，接口响应成功，返回重启在线迁移任务下发结果。	去调试
IP交换回滚	hcloud DCS RollbackExchangeInstanceIp	IP交换回滚。	去调试

标签管理

API名称	命令	描述	操作
查询租户所有标签	hcloud DCS ListTagsOfTenant	查询租户在指定Project中实例类型的所有资源标签集合。	去调试
批量添加或删除标签	hcloud DCS BatchCreateOrDeleteTags	为指定实例批量添加标签，或批量删除标签。	去调试
查询单个实例标签	hcloud DCS ShowTags	通过实例ID查询标签。	去调试

缓存分析

API名称	命令	描述	操作
创建大key分析任务	hcloud DCS CreateBigkeyScanTask	为Redis实例创建大key分析任务。	去调试
查询大key分析任务列表	hcloud DCS ListBigkeyScanTasks	查询大key分析任务列表。	去调试
查询大key分析详情	hcloud DCS ShowBigkeyScanTaskDetails	查询大key分析详情。	去调试
删除大key分析记录	hcloud DCS DeleteBigkeyScanTask	删除大key分析记录。	去调试
设置大key自动分析配置	hcloud DCS UpdateBigkeyAutoscanConfig	设置大key自动分析配置。	去调试
查询大key自动分析配置	hcloud DCS ShowBigkeyAutoscanConfig	查询大key自动分析配置。	去调试
创建热key分析任务	hcloud DCS CreateHotkeyScanTask	创建热key分析任务，Redis 3.0 不支持热key分析。	去调试
查询热key分析任务列表	hcloud DCS ListHotKeyScanTasks	查询热key分析历史记录。	去调试
查询热key分析详情	hcloud DCS ShowHotkeyTaskDetails	查询热key分析详情。	去调试
删除热key分析任务	hcloud DCS DeleteHotkeyScanTask	删除热key分析任务。	去调试
设置热key自动分析配置	hcloud DCS UpdateHotkeyAutoScanConfig	设置热key自动分析配置。	去调试
查询热key自动分析配置	hcloud DCS ShowHotkeyAutoscanConfig	查询热key自动分析配置。	去调试
创建过期key扫描任务	hcloud DCS CreateAutoExpireScanTask	创建过期key扫描任务（Redis 3.0 不支持过期key扫描）。	去调试
查询过期Key扫描记录	hcloud DCS ShowExpireKeyScanInfo	查询过期Key扫描记录。	去调试
立刻扫描过期Key	hcloud DCS ScanExpireKey	立刻扫描过期Key。	去调试
查询自动扫描配置	hcloud DCS ShowExpireAutoScanConfig	查询自动扫描配置。	去调试
修改自动扫描配置	hcloud DCS UpdateExpireAutoScanConfig	修改自动扫描配置。	去调试
下载热key	hcloud DCS DownloadHotKey	下载热key。	去调试

日志管理

API名称	命令	描述	操作
查询慢日志	hcloud DCS ListSlowlog	查询慢日志。	去调试
查询Redis运行日志列表	hcloud DCS ListRedislog	查询Redis运行日志列表。	去调试
采集Redis运行日志	hcloud DCS CreateRedislog	采集Redis运行日志。	去调试
获取日志下载链接	hcloud DCS CreateRedislogDownloadLink	获取日志下载链接。	去调试

IP白名单管理

API名称	命令	描述	操作
设置IP白名单分组	hcloud DCS UpdateIpWhitelist	为指定实例设置IP白名单分组，包含创建、停用、编辑、删除白名单四个功能。	去调试
查询指定实例的IP白名单	hcloud DCS ShowIpWhitelist	查询指定实例的IP白名单。	去调试

后台任务管理

API名称	命令	描述	操作
查询后台任务列表	hcloud DCS ListBackgroundTask	查询后台任务列表。	去调试
删除后台任务	hcloud DCS DeleteBackgroundTask	删除后台任务。	去调试
查询租户Job执行结果	hcloud DCS ShowJobInfo	查询租户Job执行结果。	去调试
查询后台任务详细信息	hcloud DCS ShowBackgroundTaskProgress	查询后台任务详细信息。	去调试
查询任务中心任务列表	hcloud DCS ListCenterTask	查询任务中心任务列表。	去调试
提交前置检查任务	hcloud DCS StartInstanceResizeCheckJob	提交前置检查任务。	去调试
查询实例列表导出任务详情	hcloud DCS ExportExcelJob	查询实例列表导出任务详情。	去调试
删除任务中心任务	hcloud DCS DeleteCenterTask	删除任务中心任务。	去调试

其他接口

API名称	命令	描述	操作
查询产品规格	hcloud DCS ListFlavors	在创建缓存实例时，需要配置订购的产品规格编码（spec_code），可通过该接口查询产品规格，查询条件不选时默认查询全部。	去调试
查询维护时间窗时间段	hcloud DCS ListMaintenanceWindows	查询维护时间窗开始时间和结束时间。	去调试
查询租户配额	hcloud DCS ShowQuotaOfTenant	查询租户默认可以创建的实例数和总内存的配额限制，以及可以申请配额的最大值和最小值。不同的租户在不同的区域配额可能不同。	去调试
查询单个主维度下子维度监控对象列表	hcloud DCS ListMonitoredObjectsOfInstance	查询主维度下子维度监控对象列表，当前支持子维度的主维度ID的有dcs_instance_id。	去调试
查询主维度信息列表	hcloud DCS ListMonitoredObjects	查询主维度对象列表，主维度ID当前支持dcs_instance_id，dcs_memcached_instance_id。	去调试
查询可用区信息	hcloud DCS ListAvailableZones	查询所在局点的可用区信息。	去调试
登出webCli	hcloud DCS LogoffWebCli	登出webCli。	去调试
执行web-cli命令V2接口	hcloud DCS ExecuteCommandMobilization	登出webCli，执行redis命令。	去调试
登录webCli	hcloud DCS LoginWebCli	登录webCli。	去调试

实例诊断

API名称	命令	描述	操作
创建实例诊断任务	hcloud DCS CreateDiagnosisTask	诊断指定的缓存实例。	去调试
查询实例诊断任务列表	hcloud DCS ListDiagnosisTasks	查询指定缓存实例诊断任务列表。	去调试
删除诊断记录	hcloud DCS DeleteDiagnosisTask	删除诊断记录。	去调试
查询指定诊断报告	hcloud DCS ShowDiagnosisTaskDetails	通过报告ID查询诊断报告的详细信息。	去调试

模板管理

API名称	命令	描述	操作
查询参数模板列表	hcloud DCS ListConfigTemplates	查询租户的参数模板列表，支持按照条件查询。	去调试
创建自定义模板	hcloud DCS CreateCustomTemplate	创建自定义模板。	去调试
查询参数模板详情	hcloud DCS ShowConfigTemplate	查询参数模板详情。	去调试
修改自定义模板	hcloud DCS UpdateConfigTemplate	修改自定义模板。	去调试
删除自定义模板	hcloud DCS DeleteConfigTemplate	删除自定义模板。	去调试

账号管理

API名称	命令	描述	操作
创建ACL账号	hcloud DCS CreateAclAccount	为redis4.0/5.0实例（Cluster集群实例除外）创建权限访问账号，包含读写和只读权限。	去调试
查询ACL账户列表	hcloud DCS ListAclAccounts	查询ACL账户列表。	去调试
修改ACL账号密码	hcloud DCS UpdateAclAccountPassWord	修改ACL账号密码。	去调试
重置ACL账号密码	hcloud DCS ResetAclAccountPassWord	重置ACL账号密码。	去调试
修改ACL角色	hcloud DCS UpdateAclAccount	修改用户的类型。	去调试
删除ACL账号	hcloud DCS DeleteAclAccount	删除所创建的ACL普通账号。	去调试
ACL账号修改备注	hcloud DCS UpdateAclAccountRemark	ACL账号修改备注。	去调试

网络安全

API名称	命令	描述	操作
开启/关闭SSL	hcloud DCS UpdateSslSwitch	开启/关闭SSL。该接口目前仅针对Redis 6.0[基础版]版本实例。	去调试
查询实例SSL信息	hcloud DCS ShowInstanceSslDetail	查询实例SSL信息。该接口目前仅针对Redis 6.0[基础版]版本实例。	去调试
下载实例SSL证书	hcloud DCS DownloadSslCert	下载实例SSL证书。该接口目前仅针对Redis 6.0[基础版]版本实例。	去调试
设置IP白名单分组异步接口	hcloud DCS UpdateIpWhitelistAsync	为指定实例设置IP白名单分组，包含创建、停用、编辑、删除白名单四个功能。返回异步任务jobId，设置白名单分组信息会覆盖掉已有的白名单信息，因此在新增IP白名单分组时，需保留已有的白名单信息后再编辑新的白名单分组信息。	去调试

会话管理

API名称	命令	描述	操作
下发查询会话列表任务	hcloud DCS ScanClients	下发查询会话列表任务。	去调试
获取会话列表	hcloud DCS ListClients	获取会话列表。	去调试
kill指定的会话	hcloud DCS HangUpClients	kill指定的会话。	去调试
下发kill指定节点或实例的全部会话任务	hcloud DCS HangUpKillAllClients	下发kill指定节点或实例的全部会话任务。	去调试

离线全量key分析

API名称	命令	描述	操作
查询离线全量key分析任务列表	hcloud DCS ListOfflineKeyAnalysisTask	查询离线全量key分析任务列表，支持Redis4.0、5.0、6.0版本及Redis企业版。	去调试
创建离线全量key分析任务	hcloud DCS CreateOfflineKeyAnalysis	创建离线全量key分析任务。离线全量key分析用于分析实例指定节点备份文件中的TOP100大key，每种数据类型前缀数量TOP50的key和每种数据类型key的内存占用和数量的分布情况。仅Redis 4.0、5.0、6.0版本及Redis企业版实例支持。	去调试
查询离线全量key分析详情	hcloud DCS ShowOfflineKeyAnalysisTask	查询离线全量key分析详情。	去调试
删除离线全量key分析记录	hcloud DCS DeleteOfflineKeyAnalysisTask	删除离线全量key分析记录。	去调试

CLI命令参考

生命周期管理

实例管理

分片与副本

参数管理

备份与恢复

数据迁移

标签管理

缓存分析

日志管理

IP白名单管理

后台任务管理

其他接口

实例诊断

模板管理

账号管理

网络安全

会话管理

离线全量key分析

相关文档

您对此文档页面的整体评价？