{
  "name": "dbdc",
  "display_name": "云数据库独享集群",
  "description": "使用api对独享集群进行拉取、创建、删除等管理操作",
  "domain": "other",
  "api_version": "2020-10-29",
  "endpoint": "dbdc.tencentcloudapi.com",
  "actions": [
    {
      "name": "DescribeDBInstances",
      "description": "本接口用于查询独享集群内的DB实例列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "独享集群实例Id",
          "example": "dbdc-56nsyijj"
        },
        {
          "name": "HostId",
          "type": "string",
          "required": false,
          "description": "独享集群主机Id",
          "example": "svr-buhfdoz8"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回数量",
          "example": "1000"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页偏移量",
          "example": "1"
        },
        {
          "name": "ShardType",
          "type": "array",
          "required": false,
          "description": "实例类型,0:mariadb, 1:tdsql",
          "example": "1",
          "item_type": "integer"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeHostList",
      "description": "本接口用于查询主机列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "独享集群实例Id",
          "example": "dbdc-test"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回数量",
          "example": "1000"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页偏移量",
          "example": "1"
        },
        {
          "name": "AssignStatus",
          "type": "array",
          "required": false,
          "description": "分配状态过滤，0-可分配，1-禁止分配",
          "example": "[0]",
          "item_type": "integer"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceDetail",
      "description": "本接口用于查询独享集群详情",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "独享集群实例Id",
          "example": "dbdc-56nsyijj"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceList",
      "description": "本接口用于查询独享集群实例列表",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回数量",
          "example": "1000"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页偏移量",
          "example": "1"
        },
        {
          "name": "OrderBy",
          "type": "string",
          "required": false,
          "description": "排序字段，createTime,instancename两者之一",
          "example": "createTime"
        },
        {
          "name": "SortBy",
          "type": "string",
          "required": false,
          "description": "排序规则，desc,asc两者之一",
          "example": "desc"
        },
        {
          "name": "ProductId",
          "type": "array",
          "required": false,
          "description": "按产品过滤，0:CDB, 1:TDSQL",
          "example": "[1]",
          "item_type": "integer"
        },
        {
          "name": "InstanceId",
          "type": "array",
          "required": false,
          "description": "按实例ID过滤",
          "example": "[\"dbdc-56nsyijj\"]",
          "item_type": "string"
        },
        {
          "name": "InstanceName",
          "type": "array",
          "required": false,
          "description": "按实例名称过滤",
          "example": "[\"excluster-for-order\"]",
          "item_type": "string"
        },
        {
          "name": "FenceId",
          "type": "array",
          "required": false,
          "description": "按金融围笼ID过滤",
          "example": "[\"cage-1-2\"]",
          "item_type": "string"
        },
        {
          "name": "Status",
          "type": "array",
          "required": false,
          "description": "按实例状态过滤, -1:已隔离, 0:创建中, 1:运行中, 2:扩容中, 3:删除中",
          "example": "[1]",
          "item_type": "integer"
        },
        {
          "name": "ClusterId",
          "type": "array",
          "required": false,
          "description": "按所属集群ID过滤",
          "example": "[\"cluster-jlfwfew\"\"]",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeInstances",
      "description": "根据不同地域不同用户，获取集群列表信息",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceTypes",
          "type": "array",
          "required": false,
          "description": "集群类型: 0 一主一备, 1 一主两备...N-1 一主N备",
          "example": "[0]",
          "item_type": "integer"
        },
        {
          "name": "ProductIds",
          "type": "array",
          "required": false,
          "description": "产品ID: 0 MYSQL，1 TDSQL",
          "example": "[1]",
          "item_type": "integer"
        },
        {
          "name": "InstanceIds",
          "type": "array",
          "required": false,
          "description": "集群uuid: 如 dbdc-q810131s",
          "example": "[\"dbdc-qhdgwfs\"]",
          "item_type": "string"
        },
        {
          "name": "FenceFlag",
          "type": "boolean",
          "required": false,
          "description": "是否按金融围笼标志搜索",
          "example": "false"
        },
        {
          "name": "InstanceName",
          "type": "string",
          "required": false,
          "description": "按实例名字模糊匹配",
          "example": "exclust"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "每页数目, 整型",
          "example": "100"
        },
        {
          "name": "PageNumber",
          "type": "integer",
          "required": false,
          "description": "页码, 整型",
          "example": "1"
        },
        {
          "name": "OrderBy",
          "type": "string",
          "required": false,
          "description": "排序字段，枚举：createtime,groupname",
          "example": "createtime"
        },
        {
          "name": "OrderByType",
          "type": "string",
          "required": false,
          "description": "排序方式: asc升序, desc降序",
          "example": "asc"
        },
        {
          "name": "InstanceStatus",
          "type": "integer",
          "required": false,
          "description": "集群状态: -2 已删除, -1 已隔离, 0 创建中, 1 运行中, 2 扩容中, 3 删除中",
          "example": "1"
        }
      ],
      "required": []
    },
    {
      "name": "ModifyInstanceName",
      "description": "本接口用于修改集群名称",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "独享集群实例Id",
          "example": "dbdc-56nsyijj"
        },
        {
          "name": "InstanceName",
          "type": "string",
          "required": false,
          "description": "独享集群实例名称",
          "example": "excluster-for-order"
        }
      ],
      "required": [
        "InstanceId"
      ]
    }
  ]
}