{
  "name": "vdb",
  "display_name": "向量数据库",
  "description": "介绍如何使用API对腾讯云向量数据库进行操作，包括创建云数据库实例、获取云数据库实例信息等。",
  "domain": "other",
  "api_version": "2023-06-16",
  "endpoint": "vdb.tencentcloudapi.com",
  "actions": [
    {
      "name": "AssociateSecurityGroups",
      "description": "本接口 (AssociateSecurityGroups) 用于安全组批量绑定多个指定实例。",
      "status": "online",
      "parameters": [
        {
          "name": "SecurityGroupIds",
          "type": "array",
          "required": true,
          "description": "要绑定的安全组 ID，类似sg-efil7***。",
          "example": "[\"sg-ajr1jzgj\"]",
          "item_type": "string"
        },
        {
          "name": "InstanceIds",
          "type": "array",
          "required": true,
          "description": "实例 ID，格式如：vdb-c1nl9***，支持指定多个实例",
          "example": "[\"vdb-eb2w7dto\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "SecurityGroupIds",
        "InstanceIds"
      ]
    },
    {
      "name": "CreateInstance",
      "description": "本接口（CreateInstance）用于创建向量数据库实例。",
      "status": "online",
      "parameters": [
        {
          "name": "VpcId",
          "type": "string",
          "required": true,
          "description": "私有网络 ID。",
          "example": "vpc-rdfkabjj"
        },
        {
          "name": "SubnetId",
          "type": "string",
          "required": true,
          "description": "私有网络 VPC 的子网 ID。",
          "example": "subnet-rdfkabj"
        },
        {
          "name": "PayMode",
          "type": "integer",
          "required": true,
          "description": "指定实例计费方式。 - 0：按量付费。 - 1：包年包月。",
          "example": "1"
        },
        {
          "name": "InstanceName",
          "type": "string",
          "required": false,
          "description": "设置实例名称。仅支持长度不超过 60 的中文/英文/数字/-/_。",
          "example": "vdb-yn67ikxud"
        },
        {
          "name": "SecurityGroupIds",
          "type": "array",
          "required": false,
          "description": "安全组 ID。",
          "example": "[\"A\",\"B\"]",
          "item_type": "string"
        },
        {
          "name": "PayPeriod",
          "type": "integer",
          "required": false,
          "description": "若计费方式为包年包月，指定包年包月续费的时长。 - 单位：月。 - 取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。",
          "example": "1"
        },
        {
          "name": "AutoRenew",
          "type": "integer",
          "required": false,
          "description": "若为包年包月计费，需指定是否开启自动续费。 - 0：不开启自动续费。 - 1：开启自动续费。",
          "example": "1"
        },
        {
          "name": "Params",
          "type": "string",
          "required": false,
          "description": "实例额外参数，通过json提交。",
          "example": "'{\"key\":\"value\"}'"
        },
        {
          "name": "ResourceTags",
          "type": "array",
          "required": false,
          "description": "以数组形式列出标签信息。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签键",
              "example": "key1"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "标签值",
              "example": "value1"
            }
          ]
        },
        {
          "name": "ProductType",
          "type": "integer",
          "required": false,
          "description": "产品版本，0-标准版，1-容量增强版",
          "example": "0"
        },
        {
          "name": "InstanceType",
          "type": "string",
          "required": false,
          "description": "实例类型。 - base：免费测试版。 - single：单机版。 - cluster：高可用版。",
          "example": "cluster"
        },
        {
          "name": "Mode",
          "type": "string",
          "required": false,
          "description": "实例类型为高可用版，需指定可用区选项。 - two：两可用区。 - three：三可用区。",
          "example": "three"
        },
        {
          "name": "GoodsNum",
          "type": "integer",
          "required": false,
          "description": "购买实例数量。",
          "example": "1"
        },
        {
          "name": "Cpu",
          "type": "integer",
          "required": false,
          "description": "指定实例所需的 CPU 核数。实例类型不同，支持的 CPU 核数存在差异。 - 计算型： 1、2、4、8、16、24、32。 - 标准型： 1、2、4、8、12、16。 - 存储型： 1、2、4、6、8。",
          "example": "1"
        },
        {
          "name": "Memory",
          "type": "integer",
          "required": false,
          "description": "指定实例所需的内存大小。单位：GB。选择具体规格，请参见[配置规格（选型）](https://cloud.tencent.com/document/product/1709/113399)。",
          "example": "1"
        },
        {
          "name": "DiskSize",
          "type": "integer",
          "required": false,
          "description": "指定实例所需的磁盘大小，单位：GB。选择具体规格，请参见[配置规格（选型）](https://cloud.tencent.com/document/product/1709/113399)。",
          "example": "20"
        },
        {
          "name": "WorkerNodeNum",
          "type": "integer",
          "required": false,
          "description": "指定实例所需配置的节点数量。选择方法，请参见[配置规格（选型）](https://cloud.tencent.com/document/product/1709/113399)。",
          "example": "1"
        }
      ],
      "required": [
        "VpcId",
        "SubnetId",
        "PayMode"
      ]
    },
    {
      "name": "DescribeDBSecurityGroups",
      "description": "本接口(DescribeDBSecurityGroups)用于查询实例的安全组详情。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID，格式如：vdb-c1nl9***。",
          "example": "vdb-c1nl9rpv"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceMaintenanceWindow",
      "description": "本接口（DescribeInstanceMaintenanceWindow）用于查看实例维护时间窗。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "指定查询维护时间窗的具体实例 ID。",
          "example": "vdb-hfeu****"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstanceNodes",
      "description": "查询实例pod列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID。",
          "example": "vdb-ay5nc8f9tq"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "limit",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "offset",
          "example": "0"
        },
        {
          "name": "Component",
          "type": "string",
          "required": false,
          "description": "component",
          "example": "worker"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DescribeInstances",
      "description": "查询实例列表",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceIds",
          "type": "array",
          "required": false,
          "description": "实例ID数组。",
          "example": "[\"vdb-77qt0r46\",\"vdb-o2ovx6ko\"]",
          "item_type": "string"
        },
        {
          "name": "InstanceNames",
          "type": "array",
          "required": false,
          "description": "实例名称，支持模糊搜索。",
          "example": "[\"vdb-test\"]",
          "item_type": "string"
        },
        {
          "name": "InstanceKeys",
          "type": "array",
          "required": false,
          "description": "实例模糊搜索字段。",
          "example": "[\"研发实例\"]",
          "item_type": "string"
        },
        {
          "name": "Status",
          "type": "array",
          "required": false,
          "description": "根据状态获取实例， 为空则获取全部非隔离和非下线的实例。",
          "example": "[\"online\"]",
          "item_type": "string"
        },
        {
          "name": "EngineVersions",
          "type": "array",
          "required": false,
          "description": "按照版本筛选实例。",
          "example": "[\"v1.6.0\"]",
          "item_type": "string"
        },
        {
          "name": "ApiVersions",
          "type": "array",
          "required": false,
          "description": "按照api版本筛选实例",
          "example": "[\"v2.0\"]",
          "item_type": "string"
        },
        {
          "name": "CreateAt",
          "type": "string",
          "required": false,
          "description": "按照创建时间筛选实例。",
          "example": "2024-01-01"
        },
        {
          "name": "OrderBy",
          "type": "string",
          "required": false,
          "description": "排序字段。",
          "example": "create_time"
        },
        {
          "name": "OrderDirection",
          "type": "string",
          "required": false,
          "description": "排序方式。",
          "example": "desc"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "查询开始位置。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "列表查询数量。",
          "example": "10"
        },
        {
          "name": "ResourceTags",
          "type": "array",
          "required": false,
          "description": "按照标签筛选实例",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签键",
              "example": "key1"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "标签值",
              "example": "value1"
            }
          ]
        },
        {
          "name": "TaskStatus",
          "type": "array",
          "required": false,
          "description": "任务状态：1-待执行任务；2-密钥更新中；3-网络变更中；4-参数变更中；5-embedding变更中；6-ai套件变更中；7-滚动升级中；8-纵向扩容中；9-纵向缩容中；10-横向扩容中；11-横向缩容中",
          "example": "[1,2]",
          "item_type": "integer"
        },
        {
          "name": "Networks",
          "type": "array",
          "required": false,
          "description": "根据实例vip搜索实例",
          "example": "[\"10.0.1.1\", \"10.11.1.1\"]",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "DescribePriceCreateInstance",
      "description": "查询新购实例价格",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceType",
          "type": "string",
          "required": true,
          "description": "实例类型。 - base：免费测试版。 - single：单机版。 - cluster：高可用版。",
          "example": "cluster"
        },
        {
          "name": "Cpu",
          "type": "integer",
          "required": true,
          "description": "指定实例所需的 CPU 核数。实例类型不同，支持的 CPU 核数存在差异。 - 计算型： 1、2、4、8、16、24、32。 - 标准型： 1、2、4、8、12、16。 - 存储型： 1、2、4、6、8。",
          "example": "1"
        },
        {
          "name": "Memory",
          "type": "integer",
          "required": true,
          "description": "指定实例所需的内存大小。单位：GB。选择具体规格，请参见[配置规格（选型）](https://cloud.tencent.com/document/product/1709/113399)。",
          "example": "1"
        },
        {
          "name": "DiskSize",
          "type": "integer",
          "required": true,
          "description": "指定实例所需的磁盘大小，单位：GB。选择具体规格，请参见[配置规格（选型）](https://cloud.tencent.com/document/product/1709/113399)。",
          "example": "20"
        },
        {
          "name": "WorkerNodeNum",
          "type": "integer",
          "required": true,
          "description": "指定实例所需配置的节点数量。选择方法，请参见[配置规格（选型）](https://cloud.tencent.com/document/product/1709/113399)。",
          "example": "1"
        },
        {
          "name": "PayMode",
          "type": "integer",
          "required": true,
          "description": "指定实例计费方式。 - 0：按量付费。 - 1：包年包月。",
          "example": "1"
        },
        {
          "name": "GoodsNum",
          "type": "integer",
          "required": true,
          "description": "购买实例数量。",
          "example": "1"
        },
        {
          "name": "ProductType",
          "type": "integer",
          "required": false,
          "description": "产品版本，0-标准版，1-容量增强版",
          "example": "0"
        },
        {
          "name": "Mode",
          "type": "string",
          "required": false,
          "description": "实例类型为高可用版，需指定可用区选项。 - two：两可用区。 - three：三可用区。",
          "example": "three"
        },
        {
          "name": "PayPeriod",
          "type": "integer",
          "required": false,
          "description": "若计费方式为包年包月，指定包年包月续费的时长。 - 单位：月。 - 取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。",
          "example": "1"
        }
      ],
      "required": [
        "InstanceType",
        "Cpu",
        "Memory",
        "DiskSize",
        "WorkerNodeNum",
        "PayMode",
        "GoodsNum"
      ]
    },
    {
      "name": "DescribePriceRenewInstance",
      "description": "查询实例续费价格（包年包月）",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "vdb-xxx"
        },
        {
          "name": "PayPeriod",
          "type": "integer",
          "required": true,
          "description": "包年包月的时长，单位：月",
          "example": "1"
        }
      ],
      "required": [
        "InstanceId",
        "PayPeriod"
      ]
    },
    {
      "name": "DescribePriceResizeInstance",
      "description": "查询实例变配价格",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "实例ID",
          "example": "vdb-xxx"
        },
        {
          "name": "Cpu",
          "type": "integer",
          "required": false,
          "description": "指定实例所需的 CPU 核数。实例类型不同，支持的 CPU 核数存在差异。 - 计算型： 1、2、4、8、16、24、32。 - 标准型： 1、2、4、8、12、16。 - 存储型： 1、2、4、6、8。",
          "example": "1"
        },
        {
          "name": "Memory",
          "type": "integer",
          "required": false,
          "description": "指定实例所需的内存大小。单位：GB。选择具体规格，请参见[配置规格（选型）](https://cloud.tencent.com/document/product/1709/113399)。",
          "example": "1"
        },
        {
          "name": "DiskSize",
          "type": "integer",
          "required": false,
          "description": "指定实例所需的磁盘大小，单位：GB。选择具体规格，请参见[配置规格（选型）](https://cloud.tencent.com/document/product/1709/113399)。",
          "example": "20"
        },
        {
          "name": "WorkerNodeNum",
          "type": "integer",
          "required": false,
          "description": "指定实例所需配置的节点数量。选择方法，请参见[配置规格（选型）](https://cloud.tencent.com/document/product/1709/113399)。",
          "example": "1"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "DestroyInstances",
      "description": "本接口（DestroyInstances）用于销毁实例。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceIds",
          "type": "array",
          "required": true,
          "description": "以数组形式指定待销毁下线的实例 ID。",
          "example": "[\"vdb-*******\", \"vdb-*******\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "InstanceIds"
      ]
    },
    {
      "name": "DisassociateSecurityGroups",
      "description": "本接口(DisassociateSecurityGroups)用于安全组批量解绑实例。",
      "status": "online",
      "parameters": [
        {
          "name": "SecurityGroupIds",
          "type": "string",
          "required": true,
          "description": "要绑定的安全组 ID，类似sg-efil****。",
          "example": "{\"sg-ajr1jzgj\"]"
        },
        {
          "name": "InstanceIds",
          "type": "array",
          "required": true,
          "description": "实例 ID，格式如：vdb-c1nl****，支持指定多个实例。",
          "example": "[\"vdb-eb2w7dto\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "SecurityGroupIds",
        "InstanceIds"
      ]
    },
    {
      "name": "IsolateInstance",
      "description": "本接口（IsolateInstance）用于隔离实例于回收站，在回收站保护时长内可恢复实例。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "指定需隔离的实例 ID。",
          "example": "vdb-****"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ModifyDBInstanceSecurityGroups",
      "description": "本接口(ModifyDBInstanceSecurityGroups)用于修改实例绑定的安全组。",
      "status": "online",
      "parameters": [
        {
          "name": "SecurityGroupIds",
          "type": "array",
          "required": true,
          "description": "要修改的安全组ID列表，一个或者多个安全组 ID 组成的数组。 注意：该入参会全量替换存量已有集合，非增量更新。修改需传入预期的全量集合。",
          "example": "[\"sg-ajr1jzgj\"]",
          "item_type": "string"
        },
        {
          "name": "InstanceIds",
          "type": "array",
          "required": true,
          "description": "实例ID，格式如：vdb-c9s3****。",
          "example": "[\"vdb-c9s3b1h4\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "SecurityGroupIds",
        "InstanceIds"
      ]
    },
    {
      "name": "ModifyInstanceMaintenanceWindow",
      "description": "本接口（ModifyInstanceMaintenanceWindow）用于修改实例维护时间窗范围。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "指定需修改维护时间窗的实例 ID。",
          "example": "vdb-dhewyr"
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": true,
          "description": "维护时间窗开始时间。取值范围为\"00:00-23:00\"的任意整点，如01:00。",
          "example": "03:00"
        },
        {
          "name": "TimeSpan",
          "type": "integer",
          "required": true,
          "description": "设置维护时间窗的时长。根据指定的维护时间窗开始时间与时长可确定维护时间窗的范围。 - 单位：小时。 - 取值范围：3、6、8、10、12。",
          "example": "1"
        }
      ],
      "required": [
        "InstanceId",
        "StartTime",
        "TimeSpan"
      ]
    },
    {
      "name": "RecoverInstance",
      "description": "本接口（RecoverInstance）用于恢复在回收站隔离的实例。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "指定待恢复的实例 ID。",
          "example": "vdb-****"
        },
        {
          "name": "PayPeriod",
          "type": "integer",
          "required": false,
          "description": "若实例为包年包月计费，需通过该参数指定续费的时长。 - 单位：月。 - 取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。",
          "example": "1"
        }
      ],
      "required": [
        "InstanceId"
      ]
    },
    {
      "name": "ScaleOutInstance",
      "description": "本接口（ScaleOutInstance）用于水平扩容节点数量。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "指定需扩容节点数量的实例 ID。",
          "example": "vdb-jnaj****"
        },
        {
          "name": "ReplicaNum",
          "type": "integer",
          "required": true,
          "description": "指定扩容后的节点数量。选项范围起始于当前实例已有的节点数，上限为30个节点。",
          "example": "3"
        },
        {
          "name": "RunNow",
          "type": "boolean",
          "required": false,
          "description": "指定水平扩容增加节点数量的时间。 - false：默认值，指在下一个维护时间段内执行增加节点数的任务。实例列表中“状态”列将显示“待执行配置变更”，等到维护时间窗内启动扩容任务。维护时间的更多信息，请参维护时间窗。 - true：立即执行增加节点数的任务，请确保此时没有重大业务操作。",
          "example": "false"
        }
      ],
      "required": [
        "InstanceId",
        "ReplicaNum"
      ]
    },
    {
      "name": "ScaleUpInstance",
      "description": "本接口（ScaleUpInstance）用于升级节点配置规格。",
      "status": "online",
      "parameters": [
        {
          "name": "InstanceId",
          "type": "string",
          "required": true,
          "description": "指定需升级配置的实例 ID。",
          "example": "vdb-iue******"
        },
        {
          "name": "Cpu",
          "type": "float",
          "required": false,
          "description": "指定升级配置后的 CPU 核数。 - 节点规格可选项（CPU \u0026 内存）必须 \u003e= 当前配置。 - 可选择的规格信息，请参见[选择节点规格与数量](https://cloud.tencent.com/document/product/1709/113399)。",
          "example": "4.0"
        },
        {
          "name": "Memory",
          "type": "float",
          "required": false,
          "description": "指定升级配置后的内存大小，单位为：GB。 - 节点规格可选项（CPU \u0026 内存）必须 \u003e= 当前配置。 - 不同实例类型对 CPU 与内存资源的配置比例有不同的要求。例如，计算型实例，CPU 与内存的分配比例要求为 1:2。CPU 被指定为 4 核，那么内存则应被指定为 8GB。节点规格的详细信息，请参见[选择节点规格与数量](https://cloud.tencent.com/document/product/1709/113399)。",
          "example": "8.0"
        },
        {
          "name": "StorageSize",
          "type": "integer",
          "required": false,
          "description": "指定升级配置后的磁盘容量。 - 单位：GB。 - 取值范围为：[10,1000]。 - 取值必须为10的倍数。",
          "example": "200"
        },
        {
          "name": "RunNow",
          "type": "boolean",
          "required": false,
          "description": "指定垂直扩容升级节点配置的时间。 - false：默认值，指在下一个维护时间段内执行升配节点规格的任务。实例列表中“状态”列将显示“待执行配置变更”，等到维护时间窗内启动任务。维护时间的更多信息，请参见维护时间窗。 - true：立即执行升级配置的任务，请确保此时没有重大业务操作。",
          "example": "false"
        }
      ],
      "required": [
        "InstanceId"
      ]
    }
  ]
}