{
  "name": "cdwch",
  "display_name": "腾讯云数据仓库TCHouse-C",
  "description": "腾讯云数据仓库 TCHouse-C（ Tencent Cloud TCHouse-C ）是基于开源 OLAP 引擎 ClickHouse 打造的企业级云数据仓库服务，仅需几分钟即可快速搭建起 PB 级实时数据仓库，实现对海量数据的极速实时分析。TChouse-C API 为用户提供便捷的 ClickHouse 集群部署、软件安装、配置修改、监控告警、弹性伸缩等功能，为企业及用户提供安全稳定的大数据处理解决方案。",
  "domain": "database",
  "api_version": "2020-09-15",
  "endpoint": "cdwch.tencentcloudapi.com",
  "actions": [
    {
      "name": "ActionAlterCkUser",
      "description": "新增和修改用户接口",
      "status": "online",
      "parameters": [
        {
          "name": "UserInfo",
          "type": "object",
          "required": true,
          "description": "用户信息",
          "example": "cdwch-xxxx",
          "children": [
            {
              "name": "InstanceId",
              "type": "string",
              "required": true,
              "description": "集群实例id",
              "example": "cdwch-xxxx"
            },
            {
              "name": "UserName",
              "type": "string",
              "required": true,
              "description": "用户名",
              "example": "test_user"
            },
            {
              "name": "PassWord",
              "type": "string",
              "required": true,
              "description": "base64加密后的密码",
              "example": "cGFzc3dvcmsK"
            },
            {
              "name": "Describe",
              "type": "string",
              "required": false,
              "description": "描述",
              "example": "测试账号"
            },
            {
              "name": "OriginalPassword",
              "type": "string",
              "required": false,
              "description": "账户的当前密码"
            }
          ]
        },
        {
          "name": "ApiType",
          "type": "string",
          "required": true,
          "description": "api接口类型， AddSystemUser新增用户，UpdateSystemUser，修改用户",
          "example": "AddSystemUser"
        }
      ],
      "required": [
        "UserInfo",
        "ApiType"
      ]
    },
    {
      "name": "CreateBackUpSchedule",
      "description": "创建或者修改备份策略",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "cdwch-xxxxxxxx"
        },
        {
          "name": "ScheduleType",
          "type": "string",
          "required": true,
          "description": "策略类型 meta(元数据) data (表数据)",
          "example": "meta"
        },
        {
          "name": "OperationType",
          "type": "string",
          "required": true,
          "description": "操作类型 create(创建) update(编辑修改)",
          "example": "create"
        },
        {
          "name": "RetainDays",
          "type": "integer",
          "required": false,
          "description": "保留天数 例如7",
          "example": "7"
        },
        {
          "name": "ScheduleId",
          "type": "integer",
          "required": false,
          "description": "编辑时需要传",
          "example": "3"
        },
        {
          "name": "WeekDays",
          "type": "string",
          "required": false,
          "description": "选择的星期 逗号分隔，例如 2 代表周二",
          "example": "1,2"
        },
        {
          "name": "ExecuteHour",
          "type": "integer",
          "required": false,
          "description": "执行小时",
          "example": "1"
        },
        {
          "name": "BackUpTables",
          "type": "array",
          "required": false,
          "description": "备份表列表",
          "example": "[\"1234\"]",
          "item_type": "object",
          "children": [
            {
              "name": "Database",
              "type": "string",
              "required": true,
              "description": "数据库",
              "example": "db_test"
            },
            {
              "name": "Table",
              "type": "string",
              "required": true,
              "description": "表",
              "example": "tb_test"
            },
            {
              "name": "TotalBytes",
              "type": "integer",
              "required": true,
              "description": "表总字节数",
              "example": "1024"
            },
            {
              "name": "VCluster",
              "type": "string",
              "required": false,
              "description": "虚拟cluster",
              "example": "cluster-xxxxxxxx"
            },
            {
              "name": "Ips",
              "type": "string",
              "required": false,
              "description": "表ip",
              "example": "10.0.0.10"
            },
            {
              "name": "ZooPath",
              "type": "string",
              "required": false,
              "description": "zk路径",
              "example": "/data"
            },
            {
              "name": "Rip",
              "type": "string",
              "required": false,
              "description": "cvm的ip地址",
              "example": "192.x.x.x"
            }
          ]
        }
      ],
      "required": [
        "InstanceId",
        "ScheduleType",
        "OperationType"
      ]
    },
    {
      "name": "CreateInstanceNew",
      "description": "创建集群",
      "status": "online",
      "parameters": [
        {
          "name": "Zone",
          "type": "string",
          "required": true,
          "description": "可用区",
          "example": "ap-beijing-2"
        },
        {
          "name": "HaFlag",
          "type": "boolean",
          "required": true,
          "description": "是否高可用",
          "example": "false"
        },
        {
          "name": "UserVPCId",
          "type": "string",
          "required": true,
          "description": "私有网络",
          "example": "vpc-8visjoh9"
        },
        {
          "name": "UserSubnetId",
          "type": "string",
          "required": true,
          "description": "子网",
          "example": "subnet-03ij1dki"
        },
        {
          "name": "ProductVersion",
          "type": "string",
          "required": true,
          "description": "系统版本",
          "example": "21.8.12.29"
        },
        {
          "name": "ChargeProperties",
          "type": "object",
          "required": true,
          "description": "计费方式",
          "example": "无",
          "children": [
            {
              "name": "ChargeType",
              "type": "string",
              "required": true,
              "description": "计费类型，“PREPAID” 预付费，“POSTPAID_BY_HOUR” 后付费",
              "example": "PREPAID"
            },
            {
              "name": "RenewFlag",
              "type": "integer",
              "required": false,
              "description": "PREPAID需要传递，是否自动续费，1表示自动续费开启",
              "example": "1"
            },
            {
              "name": "TimeSpan",
              "type": "integer",
              "required": false,
              "description": "预付费需要传递，计费时间长度，多少个月",
              "example": "1"
            }
          ]
        },
        {
          "name": "InstanceName",
          "type": "string",
          "required": true,
          "description": "实例名称",
          "example": "cdwch-test"
        },
        {
          "name": "DataSpec",
          "type": "object",
          "required": true,
          "description": "数据节点 SpecName从DescribeSpec接口中返回的DataSpec.Name获取",
          "example": "无",
          "children": [
            {
              "name": "SpecName",
              "type": "string",
              "required": true,
              "description": "规格名称",
              "example": "SCH1"
            },
            {
              "name": "Count",
              "type": "integer",
              "required": true,
              "description": "数量",
              "example": "1"
            },
            {
              "name": "DiskSize",
              "type": "integer",
              "required": true,
              "description": "云盘大小",
              "example": "200"
            }
          ]
        },
        {
          "name": "ClsLogSetId",
          "type": "string",
          "required": false,
          "description": "日志主题ID",
          "example": "\"cls-xdeaged\""
        },
        {
          "name": "CosBucketName",
          "type": "string",
          "required": false,
          "description": "COS桶名称",
          "example": "cdwch-cos"
        },
        {
          "name": "MountDiskType",
          "type": "integer",
          "required": false,
          "description": "是否是裸盘挂载，默认值 0 为 未挂载，1 为挂载。",
          "example": "0"
        },
        {
          "name": "HAZk",
          "type": "boolean",
          "required": false,
          "description": "是否是ZK高可用",
          "example": "false"
        },
        {
          "name": "CommonSpec",
          "type": "object",
          "required": false,
          "description": "ZK节点SpecName从DescribeSpec接口中返回的CommonSpec结构体的Name（ZK节点）获取",
          "example": "无",
          "children": [
            {
              "name": "SpecName",
              "type": "string",
              "required": true,
              "description": "规格名称",
              "example": "SCH1"
            },
            {
              "name": "Count",
              "type": "integer",
              "required": true,
              "description": "数量",
              "example": "1"
            },
            {
              "name": "DiskSize",
              "type": "integer",
              "required": true,
              "description": "云盘大小",
              "example": "200"
            }
          ]
        },
        {
          "name": "TagItems",
          "type": "array",
          "required": false,
          "description": "标签列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签的键",
              "example": "标签一"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "标签的值",
              "example": "内容一"
            }
          ]
        },
        {
          "name": "SecondaryZoneInfo",
          "type": "array",
          "required": false,
          "description": "副可用区信息",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "SecondaryZone",
              "type": "string",
              "required": false,
              "description": "副可用区",
              "example": "ap-guangzhou"
            },
            {
              "name": "SecondarySubnet",
              "type": "string",
              "required": false,
              "description": "可用区可用的子网id",
              "example": "subnet-test"
            },
            {
              "name": "UserIpNum",
              "type": "string",
              "required": false,
              "description": "可用区可用的子网可用ip的数量",
              "example": "1"
            },
            {
              "name": "SecondaryUserSubnetIPNum",
              "type": "integer",
              "required": false,
              "description": "可用区可用的子网可用ip的数量",
              "example": "1"
            }
          ]
        },
        {
          "name": "CkDefaultUserPwd",
          "type": "string",
          "required": false,
          "description": "default账号登陆实例的密码。8-16个字符，至少包含大写字母、小写字母、数字和特殊字符!@#%^*中的三种，第一个字符不能为特殊字符",
          "example": "Test@579"
        }
      ],
      "required": [
        "Zone",
        "HaFlag",
        "UserVPCId",
        "UserSubnetId",
        "ProductVersion",
        "ChargeProperties",
        "InstanceName",
        "DataSpec"
      ]
    },
    {
      "name": "DeleteBackUpData",
      "description": "删除备份数据",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "cdwch-xxxxxxxx"
        },
        {
          "name": "BackUpJobId",
          "type": "integer",
          "required": false,
          "description": "任务id",
          "example": "0"
        },
        {
          "name": "IsDeleteAll",
          "type": "boolean",
          "required": false,
          "description": "是否删除所有数据",
          "example": "true"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeBackUpJob",
      "description": "查询备份任务列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "\"cdwch-xxx\""
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "分页大小",
          "example": "12"
        },
        {
          "name": "PageNum",
          "type": "integer",
          "required": false,
          "description": "页号",
          "example": "10"
        },
        {
          "name": "BeginTime",
          "type": "string",
          "required": false,
          "description": "开始时间",
          "example": "\"2021-02-12\""
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": false,
          "description": "结束时间",
          "example": "\"2021-02-12\""
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeBackUpJobDetail",
      "description": "查询备份任务详情",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "\"cdwch-xxx\""
        },
        {
          "name": "BackUpJobId",
          "type": "integer",
          "required": true,
          "description": "任务id",
          "example": "12"
        }
      ],
      "required": [
        "InstanceId",
        "BackUpJobId"
      ]
    },
    {
      "name": "DescribeBackUpSchedule",
      "description": "查询备份策略信息",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "\"cdwch-xxxx\""
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeBackUpTables",
      "description": "获取可备份表信息",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "cdwch-xxxxxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeCNInstances",
      "description": "获取云原生实例列表",
      "status": "online",
      "parameters": [
        {
          "name": "SearchInstanceID",
          "type": "string",
          "required": false,
          "description": "搜索的集群id名称",
          "example": "clickhouse-cn-xxxxxx"
        },
        {
          "name": "SearchInstanceName",
          "type": "string",
          "required": false,
          "description": "搜索的集群name",
          "example": "clickhouse-cn-xxxxxx"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页参数，第一页为0，第二页为10",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页参数，分页步长，默认为10",
          "example": "20"
        },
        {
          "name": "SearchTags",
          "type": "array",
          "required": false,
          "description": "搜索标签列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": false,
              "description": "标签的键",
              "example": "标签一"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": false,
              "description": "标签的值",
              "example": "标签值一"
            },
            {
              "name": "AllValue",
              "type": "integer",
              "required": false,
              "description": "1表示只输入标签的键，没有输入值；0表示输入键时且输入值",
              "example": "1"
            }
          ]
        },
        {
          "name": "InstanceType",
          "type": "string",
          "required": false,
          "description": "集群类型，弹性版或自研数仓版",
          "example": "clickhouse-cn"
        },
        {
          "name": "Components",
          "type": "array",
          "required": false,
          "description": "组件名称列表",
          "example": "0",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeCkSqlApis",
      "description": "查询集群用户、集群表，数据库等相关信息",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例id",
          "example": "cdwch-xxxxxxxx"
        },
        {
          "name": "ApiType",
          "type": "string",
          "required": true,
          "description": "api接口名称,GetClusters:获取集群cluster列表 GetSystemUsers:获取系统用户列表 CheckNodeCluster: 检查节点是否隶属一个cluster GetClusterDatabases: 获取一个cluster下的数据库列表 GetClusterTables: 获取一个cluster下的数据库表列表 GetPrivilegeUsers: 获取授权的用户列表 GET_USER_CLUSTER_PRIVILEGES:获取用户cluster下的权限 GetUserClusterNewPrivileges:获取用户cluster下的权限 (新版） RevokeClusterUser:解绑cluster用户 DeleteSyst...",
          "example": "GetClusters"
        },
        {
          "name": "Cluster",
          "type": "string",
          "required": false,
          "description": "集群名称，当ApiType取值为GET_SYSTEM_USERS，GET_PRIVILEGE_USERS，GET_CLUSTER_DATABASES，GET_CLUSTER_TABLES 时，此参数必填",
          "example": "default"
        },
        {
          "name": "UserName",
          "type": "string",
          "required": false,
          "description": "用户名称，api与user相关的必填",
          "example": "user1"
        },
        {
          "name": "UserType",
          "type": "string",
          "required": false,
          "description": "账户的类型",
          "example": "XML"
        }
      ],
      "required": [
        "InstanceId",
        "ApiType"
      ]
    },
    {
      "name": "DescribeClusterConfigs",
      "description": "获取集群的最新的几个配置文件（config.xml、metrika.xml、user.xml）的内容，显示给用户",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群实例ID",
          "example": "cdwch-xxxxxxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeEventTasks",
      "description": "获取产生的事件",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "cdwch-yapr67z1"
        },
        {
          "name": "EventTaskId",
          "type": "integer",
          "required": false,
          "description": "过滤的事件任务id",
          "example": "27"
        },
        {
          "name": "PageNumber",
          "type": "integer",
          "required": false,
          "description": "页码，默认为1",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "每页数量（支持10、20、30、50、100、200），默认为100",
          "example": "10"
        },
        {
          "name": "EventCode",
          "type": "string",
          "required": false,
          "description": "事件名称过滤",
          "example": "DiskHigh"
        },
        {
          "name": "Status",
          "type": "array",
          "required": false,
          "description": "(1-待处理;2-已预约;3-处理中;4-已结束;5-处理中;-1-已忽略;-2-已删除)",
          "example": "[2]",
          "item_type": "integer"
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": false,
          "description": "创建时间范围开始 (格式: YYYY-MM-DD HH:MM:SS)，最大支持查询180天信息",
          "example": "2025-01-01 00:00:00"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": false,
          "description": "创建时间范围结束 (格式: YYYY-MM-DD HH:MM:SS)",
          "example": "2025-01-31 23:59:59"
        },
        {
          "name": "SortField",
          "type": "string",
          "required": false,
          "description": "排序字段（事件类型：event_code；触发时间：create_time；完成时间：end_time）",
          "example": "create_time"
        },
        {
          "name": "SortOrder",
          "type": "string",
          "required": false,
          "description": "排序顺序 (asc/desc)",
          "example": "asc"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstance",
      "description": "根据实例ID查询某个实例的具体信息",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群实例ID",
          "example": "cdwch-12345678"
        },
        {
          "name": "IsOpenApi",
          "type": "boolean",
          "required": false,
          "description": "是否是open api查询",
          "example": "false"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceClusters",
      "description": "集群vcluster列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "cdwch-xxxxxxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceKeyValConfigs",
      "description": "在集群详情页面获取所有参数列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群实例ID",
          "example": "cdwch-xxxxxxxx"
        },
        {
          "name": "SearchConfigName",
          "type": "string",
          "required": false,
          "description": "搜索的配置项名称",
          "example": "max_connections"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceNodes",
      "description": "获取实例节点信息列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群实例ID",
          "example": "cdwch-12345678"
        },
        {
          "name": "NodeRole",
          "type": "string",
          "required": false,
          "description": "集群角色类型，“DATA” 为数据节点、“COMMON” 为 ZooKeeper 节点，默认为 \"DATA\" 数据节点。",
          "example": "DATA"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页参数，第一页为0，第二页为10",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页参数，分页步长，默认为10",
          "example": "100"
        },
        {
          "name": "DisplayPolicy",
          "type": "string",
          "required": false,
          "description": "展现策略，All时显示所有",
          "example": "All"
        },
        {
          "name": "ForceAll",
          "type": "boolean",
          "required": false,
          "description": "当true的时候返回所有节点，即Limit无限大",
          "example": "false"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceShards",
      "description": "获取实例shard信息列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群实例ID",
          "example": "cdwch-12345678"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceState",
      "description": "集群详情页中显示集群状态、流程进度等",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群实例名称",
          "example": "cdwch-xxxxxxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstancesNew",
      "description": "获取实例列表，供外部sdk使用",
      "status": "online",
      "parameters": [
        {
          "name": "SearchInstanceId",
          "type": "string",
          "required": false,
          "description": "搜索的集群id名称",
          "example": "cdwch-xxxxxxxx"
        },
        {
          "name": "SearchInstanceName",
          "type": "string",
          "required": false,
          "description": "搜索的集群name",
          "example": "测试集群"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页参数，第一页为0，第二页为10",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页参数，分页步长，默认为10",
          "example": "20"
        },
        {
          "name": "SearchTags",
          "type": "array",
          "required": false,
          "description": "搜索标签列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": false,
              "description": "标签的键",
              "example": "标签一"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": false,
              "description": "标签的值",
              "example": "标签值一"
            },
            {
              "name": "AllValue",
              "type": "integer",
              "required": false,
              "description": "1表示只输入标签的键，没有输入值；0表示输入键时且输入值",
              "example": "1"
            }
          ]
        },
        {
          "name": "IsSimple",
          "type": "boolean",
          "required": false,
          "description": "信息详细与否",
          "example": "true"
        },
        {
          "name": "Vips",
          "type": "array",
          "required": false,
          "description": "vip列表",
          "example": "['127.0.0.1','192.168.10.10']",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeSpec",
      "description": "购买页拉取集群的数据节点和zookeeper节点的规格列表",
      "status": "online",
      "parameters": [
        {
          "name": "Zone",
          "type": "string",
          "required": true,
          "description": "地域信息，例如\"ap-guangzhou-1\"",
          "example": "ap-guangzhou-1"
        },
        {
          "name": "PayMode",
          "type": "string",
          "required": false,
          "description": "计费类型，PREPAID 包年包月，POSTPAID_BY_HOUR 按量计费",
          "example": "PREPAID"
        },
        {
          "name": "IsElastic",
          "type": "boolean",
          "required": false,
          "description": "是否弹性ck",
          "example": "false"
        },
        {
          "name": "CaseType",
          "type": "integer",
          "required": false,
          "description": "是否是购买页面需要的spec",
          "example": "1"
        }
      ],
      "required": [
        "Zone"
      ]
    },
    {
      "name": "DestroyInstance",
      "description": "销毁集群 open api",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "cdwch-test001"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ModifyClusterConfigs",
      "description": "在集群配置页面修改集群配置文件接口，xml模式",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群ID，例如cdwch-xxxx",
          "example": "cdwch-xxxx"
        },
        {
          "name": "ModifyConfContext",
          "type": "array",
          "required": true,
          "description": "配置文件修改信息",
          "example": "[{\"FileName\":\"users.xml\",\"FilePath\":\"/etc/clickhouse-server\",\"NewConfValue\":\"PHlhbmRleD4KICAgIDwhL\",\"OldConfValue\":\"PHlhbmRleD4KICAgIDwhLS0gUHJvZmlsZXMgb2Ygc\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "FileName",
              "type": "string",
              "required": true,
              "description": "配置文件名称",
              "example": "config.xml"
            },
            {
              "name": "OldConfValue",
              "type": "string",
              "required": true,
              "description": "配置文件旧内容，base64编码",
              "example": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K"
            },
            {
              "name": "NewConfValue",
              "type": "string",
              "required": true,
              "description": "配置文件新内容，base64编码",
              "example": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHlhbmRleD4K"
            },
            {
              "name": "FilePath",
              "type": "string",
              "required": false,
              "description": "保存配置文件的路径",
              "example": "/etc/clickhouse-server"
            },
            {
              "name": "Ip",
              "type": "string",
              "required": false,
              "description": "节点ip信息，可选参数，当修改集群节点级配置（例如keeper_config.xml）时此参数必填；",
              "example": "10.xx.xx.9"
            }
          ]
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "修改原因",
          "example": "为了性能提升"
        }
      ],
      "required": [
        "InstanceId",
        "ModifyConfContext"
      ]
    },
    {
      "name": "ModifyInstanceKeyValConfigs",
      "description": "KV模式修改配置接口",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "cdwch-7uxy36jk"
        },
        {
          "name": "AddItems",
          "type": "array",
          "required": false,
          "description": "新增配置列表",
          "example": "[{\"ConfKey\": \"keep_alive_timeout\",\"ConfValue\": \"120\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "ConfKey",
              "type": "string",
              "required": true,
              "description": "key",
              "example": "max_connections"
            },
            {
              "name": "ConfValue",
              "type": "string",
              "required": true,
              "description": "value",
              "example": "\"4097\""
            }
          ]
        },
        {
          "name": "UpdateItems",
          "type": "array",
          "required": false,
          "description": "更新配置列表",
          "example": "[{\"ConfKey\": \"keep_alive_timeout\",\"ConfValue\": \"120\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "ConfKey",
              "type": "string",
              "required": true,
              "description": "key",
              "example": "max_connections"
            },
            {
              "name": "ConfValue",
              "type": "string",
              "required": true,
              "description": "value",
              "example": "\"4097\""
            }
          ]
        },
        {
          "name": "DeleteItems",
          "type": "object",
          "required": false,
          "description": "删除配置列表",
          "example": "[{\"ConfKey\": \"keep_alive_timeout\",\"ConfValue\": \"120\"}]",
          "children": [
            {
              "name": "ConfKey",
              "type": "string",
              "required": true,
              "description": "key",
              "example": "max_connections"
            },
            {
              "name": "ConfValue",
              "type": "string",
              "required": true,
              "description": "value",
              "example": "\"4097\""
            }
          ]
        },
        {
          "name": "DelItems",
          "type": "array",
          "required": false,
          "description": "删除配置列表",
          "example": "[{\"ConfKey\": \"keep_alive_timeout\",\"ConfValue\": \"120\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "ConfKey",
              "type": "string",
              "required": true,
              "description": "key",
              "example": "max_connections"
            },
            {
              "name": "ConfValue",
              "type": "string",
              "required": true,
              "description": "value",
              "example": "\"4097\""
            }
          ]
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "备注",
          "example": "modify config xml"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ModifyUserNewPrivilege",
      "description": "针对集群账号的权限做管控（新版）",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例id",
          "example": "cdwch-xxxx"
        },
        {
          "name": "Cluster",
          "type": "string",
          "required": true,
          "description": "cluster名称",
          "example": "cdwch-xxxx"
        },
        {
          "name": "UserName",
          "type": "string",
          "required": true,
          "description": "用户名",
          "example": "cdwch-xxxx"
        },
        {
          "name": "AllDatabase",
          "type": "boolean",
          "required": true,
          "description": "是否所有数据库表",
          "example": "false"
        },
        {
          "name": "GlobalPrivileges",
          "type": "array",
          "required": false,
          "description": "全局权限",
          "example": "数组",
          "item_type": "string"
        },
        {
          "name": "DatabasePrivilegeList",
          "type": "array",
          "required": false,
          "description": "数据库表权限",
          "example": "数组",
          "item_type": "object",
          "children": [
            {
              "name": "DatabaseName",
              "type": "string",
              "required": true,
              "description": "数据库名称",
              "example": "db1"
            },
            {
              "name": "DatabasePrivileges",
              "type": "array",
              "required": false,
              "description": "库表权限，SELECT、INSERT_ALL、ALTER、TRUNCATE、DROP_TABLE、CREATE_TABLE、DROP_DATABASE",
              "example": "[\"SELECT\",\"NSERT_ALL\"]",
              "item_type": "string"
            },
            {
              "name": "TablePrivilegeList",
              "type": "array",
              "required": false,
              "description": "库下面的表权限",
              "example": "[\"SELECT\"]",
              "item_type": "object",
              "children": [
                {
                  "name": "TableName",
                  "type": "string",
                  "required": true,
                  "description": "表名称",
                  "example": "table1"
                },
                {
                  "name": "TablePrivileges",
                  "type": "array",
                  "required": true,
                  "description": "表权限列表 SELECT、INSERT_ALL、ALTER、TRUNCATE、DROP_TABLE 查询、插入、设置、清空表、删除表",
                  "example": "【】",
                  "item_type": "string"
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "InstanceId",
        "Cluster",
        "UserName",
        "AllDatabase"
      ]
    },
    {
      "name": "OpenBackUp",
      "description": "开启或者关闭策略",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "\"cdwch-XXX\""
        },
        {
          "name": "OperationType",
          "type": "string",
          "required": true,
          "description": "OPEN 或者CLOSE",
          "example": "OPEN"
        },
        {
          "name": "CosBucketName",
          "type": "string",
          "required": true,
          "description": "桶名字",
          "example": "\"cos-XXX\""
        }
      ],
      "required": [
        "InstanceId",
        "OperationType",
        "CosBucketName"
      ]
    },
    {
      "name": "RecoverBackUpJob",
      "description": "备份恢复",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "\"cdwch-xxx\""
        },
        {
          "name": "BackUpJobId",
          "type": "integer",
          "required": true,
          "description": "任务id",
          "example": "\"10098\""
        }
      ],
      "required": [
        "InstanceId",
        "BackUpJobId"
      ]
    },
    {
      "name": "ResizeDisk",
      "description": "扩容磁盘，包含扩容数据节点，zk节点",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例唯一ID",
          "example": "cdwch-sdf34dsf"
        },
        {
          "name": "Type",
          "type": "string",
          "required": true,
          "description": "节点类型，DATA：clickhouse节点，COMMON：为zookeeper节点",
          "example": "DATA"
        },
        {
          "name": "DiskSize",
          "type": "integer",
          "required": true,
          "description": "磁盘扩容后容量，不能小于原有用量。clickhouse最小200，且为100的整数倍。 zk最小100，且为10的整数倍；",
          "example": "300"
        }
      ],
      "required": [
        "InstanceId",
        "Type",
        "DiskSize"
      ]
    },
    {
      "name": "RestartInstance",
      "description": "重启实例，可以按节点类型和节点进行重启，可选滚动重启",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例id",
          "example": "cdwch-xxxxxxxx"
        },
        {
          "name": "NodeType",
          "type": "string",
          "required": true,
          "description": "节点类型，可选值：CK / ZK / CHPROXY",
          "example": "CK"
        },
        {
          "name": "NodeIpList",
          "type": "array",
          "required": true,
          "description": "符合节点类型的要重启的节点ip列表",
          "example": "[\"10.xx.xx.1\",\"10.xx.xx.2\"]",
          "item_type": "string"
        },
        {
          "name": "RollingRestart",
          "type": "boolean",
          "required": false,
          "description": "是否滚动重启，默认为true",
          "example": "true"
        }
      ],
      "required": [
        "InstanceId",
        "NodeType",
        "NodeIpList"
      ]
    },
    {
      "name": "ScaleCNOutUpInstance",
      "description": "open-api接口提供弹性伸缩云原生集群能力",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例唯一ID",
          "example": "clickhouse-cn-xxx"
        },
        {
          "name": "VirtualCluster",
          "type": "string",
          "required": true,
          "description": "warehouse名称",
          "example": "warehouse-test"
        },
        {
          "name": "UserSubnetID",
          "type": "string",
          "required": true,
          "description": "子网id",
          "example": "subnet-xxx"
        },
        {
          "name": "NewCount",
          "type": "integer",
          "required": true,
          "description": "新的warehouse的个数",
          "example": "1"
        },
        {
          "name": "NewSpecName",
          "type": "string",
          "required": true,
          "description": "集群的规格2X-Small、X-Small、Small",
          "example": "2X-Small"
        }
      ],
      "required": [
        "InstanceId",
        "VirtualCluster",
        "UserSubnetID",
        "NewCount",
        "NewSpecName"
      ]
    },
    {
      "name": "ScaleOutInstance",
      "description": "调整clickhouse节点数量",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例唯一ID",
          "example": "cdwch-xxxxxxxx"
        },
        {
          "name": "Type",
          "type": "string",
          "required": true,
          "description": "节点类型，DATA：clickhouse节点，COMMON：为zookeeper节点",
          "example": "DATA"
        },
        {
          "name": "NodeCount",
          "type": "integer",
          "required": true,
          "description": "调整clickhouse节点数量",
          "example": "4"
        },
        {
          "name": "ScaleOutCluster",
          "type": "string",
          "required": false,
          "description": "v_cluster分组， 新增扩容节点将加入到已选择的v_cluster分组中，提交同步VIP生效.",
          "example": "default_cluster"
        },
        {
          "name": "UserSubnetIPNum",
          "type": "integer",
          "required": false,
          "description": "子网剩余ip数量，用于判断当前实例子网剩余ip数是否能扩容。需要根据实际填写",
          "example": "22"
        },
        {
          "name": "ScaleOutNodeIp",
          "type": "string",
          "required": false,
          "description": "同步元数据节点IP （uip），扩容的时候必填",
          "example": "10.0.20.163"
        },
        {
          "name": "ReduceShardInfo",
          "type": "array",
          "required": false,
          "description": "缩容节点shard的节点IP （uip），其中ha集群需要主副节点ip都传入以逗号分隔，缩容的时候必填",
          "example": "ha集群:[\"10.0.20.163,10.0.20.163\"],非ha集群:[\"10.0.20.163\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "InstanceId",
        "Type",
        "NodeCount"
      ]
    },
    {
      "name": "ScaleUpInstance",
      "description": "垂直扩缩容节点规格，修改节点cvm的规格cpu，内存。 规格变化阶段，服务不可用。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例唯一ID",
          "example": "cdwch-sdf34dsf"
        },
        {
          "name": "Type",
          "type": "string",
          "required": true,
          "description": "节点类型，DATA：clickhouse节点，COMMON：为zookeeper节点",
          "example": "DATA"
        },
        {
          "name": "SpecName",
          "type": "string",
          "required": true,
          "description": "clickhouse节点规格。",
          "example": "SCH4"
        },
        {
          "name": "ScaleUpEnableRolling",
          "type": "boolean",
          "required": true,
          "description": "是否滚动重启，false为不滚动重启，true为滚动重启",
          "example": "false"
        }
      ],
      "required": [
        "InstanceId",
        "Type",
        "SpecName",
        "ScaleUpEnableRolling"
      ]
    }
  ]
}