{
  "name": "tdmysql",
  "display_name": "TDSQL",
  "description": "新技术形态产品的实例管理API，包括生命周期，管理功能等；",
  "domain": "other",
  "api_version": "2021-11-22",
  "endpoint": "tdmysql.tencentcloudapi.com",
  "actions": [
    {
      "name": "CancelIsolateDBInstances",
      "description": "本接口（CancelIsolateDBInstances）提供批量解除隔离实例功能",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceIds",
          "type": "array",
          "required": true,
          "description": "需要隔离的实例ID列表",
          "example": "[\"tdsql3-d8fffc3c\",\"tdsql3-d8fffc4s\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "InstanceIds"
      ]
    },
    {
      "name": "CreateDBSBackup",
      "description": "创建实例备份集",
      "status": "online",
      "parameters": [
        {
          "name": "BackupMethod",
          "type": "string",
          "required": true,
          "description": "备份方式：physical、snapshot 这个值和DescribeDBSBackupPolicy接口返回的backupMethod保持一致枚举值： physical： 物理备份 snapshot： 快照备份",
          "example": "physical"
        },
        {
          "name": "BackupType",
          "type": "string",
          "required": true,
          "description": "备份类型：暂时只支持full",
          "example": "full"
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "tdsql3-f31c034x"
        },
        {
          "name": "BackupName",
          "type": "string",
          "required": false,
          "description": "备份备注",
          "example": "mybak"
        }
      ],
      "required": [
        "BackupMethod",
        "BackupType",
        "InstanceId"
      ]
    },
    {
      "name": "DeleteDBSBackupSets",
      "description": "删除实例备份集",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "tdsql3-f31c034x"
        },
        {
          "name": "BackupSetIdList",
          "type": "array",
          "required": false,
          "description": "备份集列表 ,值来自 DescribeDBSBackupSets 接口返回",
          "example": "[1]",
          "item_type": "integer"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeDBParameters",
      "description": "本接口（DescribeDBParameters）用于获取实例的当前参数设置。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例 ID，形如：tdsql3-ow728lmc。",
          "example": "tdsql3-ow728lmc"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeDBSAvailableRecoveryTime",
      "description": "可恢复时间查询",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "db实例ID",
          "example": "tdsql3-d2ba1f6b"
        },
        {
          "name": "BackupSetId",
          "type": "integer",
          "required": false,
          "description": "备份集ID,值来自 DescribeDBSBackupSets 接口返回",
          "example": "36154356969282"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeDBSCloneInstances",
      "description": "查询实例克隆列表",
      "status": "online",
      "parameters": [
        {
          "name": "SourceInstanceId",
          "type": "string",
          "required": true,
          "description": "源实例ID",
          "example": "tdsql3-b4d8fd2c"
        },
        {
          "name": "DBType",
          "type": "string",
          "required": false,
          "description": "引擎类型",
          "example": "tdstore"
        },
        {
          "name": "EndCreateTime",
          "type": "string",
          "required": false,
          "description": "结束创建时间",
          "example": "2024-11-25 10:10:00"
        },
        {
          "name": "FilterCloneType",
          "type": "string",
          "required": false,
          "description": "克隆类型: PITR 时间点 BackupSet 备份集",
          "example": "PITR"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "查询数量[0,200]",
          "example": "20"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询偏移量[0,INF]",
          "example": "0"
        },
        {
          "name": "OrderBy",
          "type": "string",
          "required": false,
          "description": "排序字段: CloneTime,CreateTime",
          "example": "CloneTime"
        },
        {
          "name": "OrderType",
          "type": "string",
          "required": false,
          "description": "排序类型:ASC,DESC",
          "example": "DESC"
        },
        {
          "name": "StartCreateTime",
          "type": "string",
          "required": false,
          "description": "开始创建时间",
          "example": "2024-11-24 10:10:00"
        }
      ],
      "required": [
        "SourceInstanceId"
      ]
    },
    {
      "name": "DescribeDBSecurityGroups",
      "description": "本接口（DescribeDBSecurityGroups）用于查询实例安全组信息",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID。",
          "example": "tdsql3eb2w7dto"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeDatabaseObjects",
      "description": "本接口（DescribeDatabaseObjects）用于查询云数据库实例的数据库中的对象列表，包含表、存储过程、视图和函数。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例 ID，形如：tdsql3-42f40429.",
          "example": "tdsql3-42f40429"
        },
        {
          "name": "DbName",
          "type": "string",
          "required": true,
          "description": "数据库名称，通过 DescribeDatabases 接口获取。",
          "example": "mysql"
        }
      ],
      "required": [
        "InstanceId",
        "DbName"
      ]
    },
    {
      "name": "DescribeFlow",
      "description": "本接口（DescribeFlow）用于查询异步任务流程状态",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "DestroyInstances",
      "description": "本接口（DestroyInstances）提供批量销毁实例功能",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceIds",
          "type": "array",
          "required": true,
          "description": "需要隔离的实例ID列表",
          "example": "[\"tdsql3-d8fffc3c\",\"tdsql3-d8fffc4s\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "InstanceIds"
      ]
    },
    {
      "name": "IsolateDBInstance",
      "description": "本接口（IsolateDBInstance）提供批量隔离实例功能",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceIds",
          "type": "array",
          "required": true,
          "description": "需要隔离的实例ID列表",
          "example": "[\"tdsql3-d8fffc3c\",\"tdsql3-d8fffc4s\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "InstanceIds"
      ]
    },
    {
      "name": "ModifyAutoRenewFlag",
      "description": "本接口（ModifyAutoRenewFlag）用于修改自动续费标志",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceIds",
          "type": "array",
          "required": true,
          "description": "需要修改的实例列表",
          "example": "[\"tdsql3-e234db15\"]",
          "item_type": "string"
        },
        {
          "name": "AutoRenewFlag",
          "type": "integer",
          "required": true,
          "description": "1表示开启自动续费，0为关闭自动续费",
          "example": "1"
        }
      ],
      "required": [
        "InstanceIds",
        "AutoRenewFlag"
      ]
    },
    {
      "name": "ModifyDBInstanceSecurityGroups",
      "description": "本接口（ModifyDBInstanceSecurityGroups）用于修改云数据库安全组",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID。",
          "example": "tdsql3-eb2w7dto"
        },
        {
          "name": "SecurityGroupIds",
          "type": "array",
          "required": true,
          "description": "要修改的安全组 ID 列表，一个或者多个安全组 ID 组成的数组。",
          "example": "[\"sg-ajr1jzgj\\n\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "InstanceId",
        "SecurityGroupIds"
      ]
    },
    {
      "name": "ModifyDBParameters",
      "description": "本接口（ModifyDBParameters）用于修改实例参数。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例 ID，形如：tdsql3-ow728lmc。",
          "example": "tdsql3-ige1a5k3"
        },
        {
          "name": "Params",
          "type": "array",
          "required": true,
          "description": "参数列表，每一个元素是Param和Value的组合",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Param",
              "type": "string",
              "required": true,
              "description": "参数名称",
              "example": "\"lower_case_table_names\""
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "参数值",
              "example": "\"0\""
            }
          ]
        }
      ],
      "required": [
        "InstanceId",
        "Params"
      ]
    },
    {
      "name": "ModifyDBSBackupPolicy",
      "description": "修改实例备份策略",
      "status": "online",
      "parameters": [
        {
          "name": "BackupPolicy",
          "type": "object",
          "required": true,
          "description": "备份策略",
          "example": "无",
          "children": [
            {
              "name": "BackupEndTime",
              "type": "string",
              "required": false,
              "description": "备份结束时间",
              "example": "04:00"
            },
            {
              "name": "BackupMethod",
              "type": "string",
              "required": false,
              "description": "备份方式 physical 物理备份 snapshot 快照备份",
              "example": "physical"
            },
            {
              "name": "BackupStartTime",
              "type": "string",
              "required": false,
              "description": "备份开始时间",
              "example": "00:00"
            },
            {
              "name": "EnableFull",
              "type": "integer",
              "required": false,
              "description": "是否开启全量备份",
              "example": "1"
            },
            {
              "name": "EnableLog",
              "type": "integer",
              "required": false,
              "description": "是否开启日志备份",
              "example": "1"
            },
            {
              "name": "FullRetentionPeriod",
              "type": "integer",
              "required": false,
              "description": "全备保留时间,目前只能设置7天",
              "example": "7"
            },
            {
              "name": "InstanceId",
              "type": "string",
              "required": false,
              "description": "实例ID",
              "example": "tdsql3-b8dfc518"
            },
            {
              "name": "LogRetentionPeriod",
              "type": "integer",
              "required": false,
              "description": "日志保留天数，目前只能设置保留7天",
              "example": "7"
            },
            {
              "name": "PeriodTime",
              "type": "string",
              "required": false,
              "description": "一周的哪几天进行备份",
              "example": "0,1,2,3,4,5,6"
            },
            {
              "name": "StorageType",
              "type": "string",
              "required": false,
              "description": "存储类型:COS,SNAPSHOT枚举值： COS： COS存储 SNAPSHOT： 云盘快照",
              "example": "COS"
            }
          ]
        },
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "tdsql3-b8dfc518"
        }
      ],
      "required": [
        "BackupPolicy",
        "InstanceId"
      ]
    },
    {
      "name": "ModifyDBSBackupSetComment",
      "description": "修改备份集备注",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "tdsql3-f31c034x"
        },
        {
          "name": "BackupSetId",
          "type": "integer",
          "required": true,
          "description": "备份集ID,值来自 DescribeDBSBackupSets 接口返回",
          "example": "1"
        },
        {
          "name": "NewBackupName",
          "type": "string",
          "required": true,
          "description": "备份备注",
          "example": "my-backup"
        }
      ],
      "required": [
        "InstanceId",
        "BackupSetId",
        "NewBackupName"
      ]
    },
    {
      "name": "ModifyInstanceName",
      "description": "本接口（ModifyInstanceName）提供修改实例名称功能",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "需要修改的实例id",
          "example": "\"tdsql3-e732378b\""
        },
        {
          "name": "InstanceName",
          "type": "string",
          "required": true,
          "description": "修改的实例名称，要求长度1-60，允许包含中文、英文大小写、数字、-、_",
          "example": "\"new-instance-name\""
        }
      ],
      "required": [
        "InstanceId",
        "InstanceName"
      ]
    }
  ]
}