{
  "name": "cdwpg",
  "display_name": "腾讯云数据仓库TCHouse-P",
  "description": "官网对外接口",
  "domain": "database",
  "api_version": "2020-12-30",
  "endpoint": "cdwpg.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateInstanceByApi",
      "description": "创建集群",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceName",
          "type": "string",
          "required": true,
          "description": "实例名称",
          "example": "cdwpg-test"
        },
        {
          "name": "Zone",
          "type": "string",
          "required": true,
          "description": "可用区",
          "example": "ap-beijing-6"
        },
        {
          "name": "UserVPCId",
          "type": "string",
          "required": true,
          "description": "私有网络",
          "example": "vpc-1asw4o72"
        },
        {
          "name": "UserSubnetId",
          "type": "string",
          "required": true,
          "description": "子网",
          "example": "subnet-rdlodajh"
        },
        {
          "name": "ChargeProperties",
          "type": "object",
          "required": true,
          "description": "计费方式",
          "example": "{\"ChargeType\":\"POSTPAID_BY_HOUR\",\"RenewFlag\":0,\"TimeSpan\":1,\"TimeUnit\":\"h\"}",
          "children": [
            {
              "name": "RenewFlag",
              "type": "integer",
              "required": true,
              "description": "1-需要自动续期",
              "example": "1"
            },
            {
              "name": "TimeSpan",
              "type": "integer",
              "required": true,
              "description": "订单时间范围",
              "example": "1"
            },
            {
              "name": "TimeUnit",
              "type": "string",
              "required": true,
              "description": "时间单位，一般为h和m",
              "example": "m"
            },
            {
              "name": "PayMode",
              "type": "integer",
              "required": false,
              "description": "计费类型0-按量计费，1-包年包月",
              "example": "0"
            },
            {
              "name": "ChargeType",
              "type": "string",
              "required": false,
              "description": "PREPAID、POSTPAID_BY_HOUR",
              "example": "PREPAID"
            }
          ]
        },
        {
          "name": "AdminPassword",
          "type": "string",
          "required": true,
          "description": "集群密码",
          "example": "cdw_2025"
        },
        {
          "name": "Resources",
          "type": "array",
          "required": true,
          "description": "资源信息",
          "example": "[{\"Count\":2,\"DiskSpec\":{\"DiskCount\":1,\"DiskSize\":200,\"DiskType\":\"CLOUD_HSSD\"},\"SpecName\":\"S_4_16_H_CN\",\"Type\":\"cn\"},{\"Count\":2,\"DiskSpec\":{\"DiskCount\":10,\"DiskSize\":20,\"DiskType\":\"CLOUD_HSSD\"},\"SpecName\":\"S_4_16_H\",\"Type\":\"dn\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "SpecName",
              "type": "string",
              "required": true,
              "description": "资源名称",
              "example": "S_4_16_H_CN"
            },
            {
              "name": "Count",
              "type": "integer",
              "required": true,
              "description": "资源数",
              "example": "200"
            },
            {
              "name": "DiskSpec",
              "type": "object",
              "required": true,
              "description": "磁盘信息",
              "example": "{ \"DiskType\": \"CLOUD_HSSD\", \"DiskSize\": 20, \"DiskCount\": 10 }",
              "children": [
                {
                  "name": "DiskType",
                  "type": "string",
                  "required": true,
                  "description": "盘类型",
                  "example": "CLOUD_SSD"
                },
                {
                  "name": "DiskSize",
                  "type": "integer",
                  "required": true,
                  "description": "大小",
                  "example": "20"
                },
                {
                  "name": "DiskCount",
                  "type": "integer",
                  "required": true,
                  "description": "个数",
                  "example": "10"
                }
              ]
            },
            {
              "name": "Type",
              "type": "string",
              "required": true,
              "description": "资源类型，DATA",
              "example": "cn"
            }
          ]
        },
        {
          "name": "ProductVersion",
          "type": "string",
          "required": false,
          "description": "版本",
          "example": "3.16.9.4"
        },
        {
          "name": "TagItems",
          "type": "array",
          "required": false,
          "description": "标签列表",
          "example": "[{\"TagKey\":\"k1\",\"TagValue\":\"v1\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签的键",
              "example": "标签一"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "标签的值",
              "example": "内容一"
            }
          ]
        }
      ],
      "required": [
        "InstanceName",
        "Zone",
        "UserVPCId",
        "UserSubnetId",
        "ChargeProperties",
        "AdminPassword",
        "Resources"
      ]
    },
    {
      "name": "DescribeAccounts",
      "description": "获取云原生实例对应的账号列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "cdwpg-cdxfxxx"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为20，最大值为100",
          "example": "20"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeDBConfigHistory",
      "description": "DescribeDBConfigHistory1",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例Id",
          "example": "cdwpg-as"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "数据库分页",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "数据库分页",
          "example": "1"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeDBParams",
      "description": "配置描述",
      "status": "online",
      "parameters": [
        {
          "name": "NodeTypes",
          "type": "array",
          "required": false,
          "description": "cn/dn",
          "example": "[\"cn\",\"dn\"]",
          "item_type": "string"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页参数，分页步长，默认为10 示例值：10",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页参数，第一页为0，第二页为10",
          "example": "0"
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": false,
          "description": "InstanceId名称",
          "example": "cdwpg-xxdfsxxx"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeErrorLog",
      "description": "查询错误日志",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群实例ID",
          "example": "cdwpg-12345678"
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": true,
          "description": "起始时间",
          "example": "2021-12-12 12:12:12"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": true,
          "description": "结束时间",
          "example": "2021-12-12 12:12:12"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为20，最大值为2000",
          "example": "20"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0",
          "example": "0"
        }
      ],
      "required": [
        "InstanceId",
        "StartTime",
        "EndTime"
      ]
    },
    {
      "name": "DescribeInstance",
      "description": "根据实例ID查询某个实例的具体信息",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群实例ID",
          "example": "cdwpg-fsdsxxdd"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceInfo",
      "description": "获取集群信息",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群实例ID",
          "example": "cdwpg-cch1234"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceNodes",
      "description": "节点list",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群ID",
          "example": "cdwpg-cdfsfsxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceOperations",
      "description": "在集群详情页面，拉取该集群的操作",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群ID",
          "example": "cdwpg-xxxx"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页参数，偏移量，从0开始",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页参数，每页数目，默认为10",
          "example": "10"
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": false,
          "description": "开始时间",
          "example": "2024-12-21 12:12:12"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": false,
          "description": "结束时间",
          "example": "2024-12-21 12:12:12"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceState",
      "description": "集群详情页中显示集群状态、流程进度等",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群实例名称",
          "example": "cdwpg-cdsxxxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstances",
      "description": "获取云原生实例列表",
      "status": "online",
      "parameters": [
        {
          "name": "SearchInstanceId",
          "type": "string",
          "required": false,
          "description": "用集群id搜索",
          "example": "cdwpg-xxxx"
        },
        {
          "name": "SearchInstanceName",
          "type": "string",
          "required": false,
          "description": "用集群名字搜索",
          "example": "cdwpg_test"
        },
        {
          "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": "[{\"TagKey\":\"k1\",\"TagValue\":\"v1\",\"AllValue\":1}]",
          "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"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "DescribeSimpleInstances",
      "description": "获取集群实例列表",
      "status": "online",
      "parameters": [
        {
          "name": "SearchInstanceId",
          "type": "string",
          "required": false,
          "description": "用集群id搜索",
          "example": "cdwpg-fsds123xxs"
        },
        {
          "name": "SearchInstanceName",
          "type": "string",
          "required": false,
          "description": "用集群名字搜索",
          "example": "cdwpg_test001"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页参数，第一页为0，第二页为10",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页参数，分页步长，默认为10",
          "example": "10"
        },
        {
          "name": "SearchTags",
          "type": "array",
          "required": false,
          "description": "用标签列表搜索",
          "example": "k1",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeSlowLog",
      "description": "查询慢SQL日志",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群实例ID",
          "example": "cdwpg-cdsbxxxxx"
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": true,
          "description": "起始时间",
          "example": "2015-09-12 13:15:14"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": true,
          "description": "结束时间",
          "example": "2015-12-12 13:12:12"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回数量，默认为20，最大值为2000",
          "example": "20"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0",
          "example": "0"
        },
        {
          "name": "Database",
          "type": "string",
          "required": false,
          "description": "数据库",
          "example": "cdwpg"
        },
        {
          "name": "OrderBy",
          "type": "string",
          "required": false,
          "description": "排序根据",
          "example": "CallTimes"
        },
        {
          "name": "OrderByType",
          "type": "string",
          "required": false,
          "description": "升降序",
          "example": "DESC"
        },
        {
          "name": "Duration",
          "type": "float",
          "required": false,
          "description": "过滤时间",
          "example": "5.2"
        },
        {
          "name": "UserName",
          "type": "string",
          "required": false,
          "description": "执行用户",
          "example": "cran"
        },
        {
          "name": "QueryString",
          "type": "string",
          "required": false,
          "description": "query 语句",
          "example": "select * from t1;"
        }
      ],
      "required": [
        "InstanceId",
        "StartTime",
        "EndTime"
      ]
    },
    {
      "name": "DescribeUpgradeList",
      "description": "升级记录",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群ID",
          "example": "cdwpg-xxxx"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页参数，偏移量，从0开始",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页参数，每页数目，默认为10",
          "example": "10"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeUserHbaConfig",
      "description": "user_hba",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "cdwpg-cdxb1xxx"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DestroyInstanceByApi",
      "description": "销毁集群",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例名称，例如\"cdwpg-xxxx\"",
          "example": "\"cdwpg-xxxx\""
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ModifyDBParameters",
      "description": "集群配置下发",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": false,
          "description": "Instance 名字",
          "example": "cdwpg-dsxrfxxxx"
        },
        {
          "name": "NodeConfigParams",
          "type": "array",
          "required": false,
          "description": "node参数",
          "example": "[{\"NodeType\":\"cn\",\"ConfigParams\":[{\"ParameterName\":\"max_connections\",\"ParameterValue\":630,\"ParameterOldValue\":\"625\"}]}]",
          "item_type": "object",
          "children": [
            {
              "name": "NodeType",
              "type": "string",
              "required": true,
              "description": "node类型",
              "example": "cn"
            },
            {
              "name": "ConfigParams",
              "type": "array",
              "required": true,
              "description": "参数",
              "example": "[{\"ParameterName\":\"max_connections\",\"ParameterValue\":630,\"ParameterOldValue\":\"625\"}]",
              "item_type": "object",
              "children": [
                {
                  "name": "ParameterName",
                  "type": "string",
                  "required": false,
                  "description": "名字",
                  "example": "Name"
                },
                {
                  "name": "ParameterValue",
                  "type": "string",
                  "required": false,
                  "description": "值",
                  "example": "value"
                },
                {
                  "name": "ParameterOldValue",
                  "type": "string",
                  "required": false,
                  "description": "修改前的值",
                  "example": "value"
                }
              ]
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "ModifyInstance",
      "description": "修改实例信息，目前为实例名称",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例Id",
          "example": "cdwpg-xsdfe12345678"
        },
        {
          "name": "InstanceName",
          "type": "string",
          "required": true,
          "description": "新修改的实例名称",
          "example": "cdwpg-test100"
        }
      ],
      "required": [
        "InstanceId",
        "InstanceName"
      ]
    },
    {
      "name": "ModifyUserHba",
      "description": "修改用户Hba配置",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "cdwpg-cdsfxxxxx"
        },
        {
          "name": "HbaConfigs",
          "type": "array",
          "required": false,
          "description": "hba数组",
          "example": "[{\"Type\":\"host\",\"Database\":\"all\",\"User\":\"all\",\"Address\":\"9.0.0.0/24\",\"Mask\":0,\"Method\":\"md5\"},{\"Type\":\"host\",\"Database\":\"all\",\"User\":\"all\",\"Address\":\"0.0.0.0/0\",\"Mask\":\"\",\"Method\":\"md5\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "Type",
              "type": "string",
              "required": true,
              "description": "类型",
              "example": "host"
            },
            {
              "name": "Database",
              "type": "string",
              "required": true,
              "description": "数据库",
              "example": "all"
            },
            {
              "name": "User",
              "type": "string",
              "required": true,
              "description": "用户",
              "example": "all"
            },
            {
              "name": "Address",
              "type": "string",
              "required": true,
              "description": "ip地址",
              "example": "0.0.0.0/0"
            },
            {
              "name": "Method",
              "type": "string",
              "required": true,
              "description": "方法",
              "example": "md5"
            },
            {
              "name": "Mask",
              "type": "string",
              "required": false,
              "description": "是否遮盖",
              "example": "0"
            }
          ]
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ResetAccountPassword",
      "description": "修改账号密码",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例Id",
          "example": "cdwpg-cdwsfsxxx"
        },
        {
          "name": "UserName",
          "type": "string",
          "required": true,
          "description": "需要修改的用户名",
          "example": "dbadmin"
        },
        {
          "name": "NewPassword",
          "type": "string",
          "required": true,
          "description": "新密码",
          "example": "cdwpg123456"
        }
      ],
      "required": [
        "InstanceId",
        "UserName",
        "NewPassword"
      ]
    },
    {
      "name": "RestartInstance",
      "description": "用户在控制台主动发起重启实例",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例名称，例如“cdwpg-xxxx\"",
          "example": "\"cdwpg-13456\""
        },
        {
          "name": "NodeTypes",
          "type": "array",
          "required": false,
          "description": "需要重启的节点类型么，gtm/cn/dn/fn",
          "example": "[\"cn0001\",\"dn0001\"]",
          "item_type": "string"
        },
        {
          "name": "NodeIds",
          "type": "array",
          "required": false,
          "description": "需要重启的节点编号，指定重启节点",
          "example": "[\"1223\",\"1234\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ScaleOutInstance",
      "description": "水平扩容",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群名",
          "example": "cdwpg-cddfsxxxx"
        },
        {
          "name": "NodeType",
          "type": "string",
          "required": true,
          "description": "节点类型",
          "example": "dn"
        },
        {
          "name": "ScaleOutCount",
          "type": "integer",
          "required": true,
          "description": "扩容节点数量",
          "example": "2"
        }
      ],
      "required": [
        "InstanceId",
        "NodeType",
        "ScaleOutCount"
      ]
    },
    {
      "name": "ScaleUpInstance",
      "description": "控制台垂直变配集群",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群唯一ID",
          "example": "cdwpg-xxxxx"
        },
        {
          "name": "Case",
          "type": "string",
          "required": true,
          "description": "变更资源类型",
          "example": "scale_up_instance"
        },
        {
          "name": "ModifySpec",
          "type": "object",
          "required": true,
          "description": "修改的参数",
          "example": "{\"Type\":\"cn\",\"SpecName\":\"S_8_32_P_CN\",\"Count\":2,\"DiskSpec\":{\"DiskType\":\"CLOUD_HSSD\",\"DiskSize\":400,\"DiskCount\":1}}",
          "children": [
            {
              "name": "Type",
              "type": "string",
              "required": true,
              "description": "节点类型",
              "example": "cn/dn"
            },
            {
              "name": "SpecName",
              "type": "string",
              "required": true,
              "description": "机型",
              "example": "S_8_32_P_CN"
            },
            {
              "name": "Count",
              "type": "integer",
              "required": true,
              "description": "节点个数",
              "example": "2"
            },
            {
              "name": "DiskSpec",
              "type": "object",
              "required": true,
              "description": "磁盘信息",
              "example": "{\"DiskType\":\"CLOUD_HSSD\",\"DiskSize\":400,\"DiskCount\":1}",
              "children": [
                {
                  "name": "DiskType",
                  "type": "string",
                  "required": true,
                  "description": "盘类型",
                  "example": "CLOUD_SSD"
                },
                {
                  "name": "DiskSize",
                  "type": "integer",
                  "required": true,
                  "description": "大小",
                  "example": "20"
                },
                {
                  "name": "DiskCount",
                  "type": "integer",
                  "required": true,
                  "description": "个数",
                  "example": "10"
                }
              ]
            }
          ]
        },
        {
          "name": "InstanceName",
          "type": "string",
          "required": false,
          "description": "集群名称",
          "example": "cdwpg-test"
        }
      ],
      "required": [
        "InstanceId",
        "Case",
        "ModifySpec"
      ]
    },
    {
      "name": "UpgradeInstance",
      "description": "在线升级",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "集群id",
          "example": "cdwpg-csvvxxxx"
        },
        {
          "name": "PackageVersion",
          "type": "string",
          "required": true,
          "description": "安装包版本",
          "example": "3.16.9.3"
        }
      ],
      "required": [
        "InstanceId",
        "PackageVersion"
      ]
    }
  ]
}