文档首页/ 云数据库 RDS/ API参考/ API v3/ 实例管理/ 查询向量存储状态 - ShowVectorStorageConfig
更新时间:2026-11-02 GMT+08:00
分享

查询向量存储状态 - ShowVectorStorageConfig

功能介绍

查询向量存储状态。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

rds:instance:getVectorStorageConfig

read

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

rds:instance:getVectorStorageConfig

-

接口约束

仅支持MySQL引擎,且内核版本需要大于等于8.0.43.260600。

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/vector-storage

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    参数解释:

    租户在某一region下的project ID。

    获取方法请参见获取项目ID。

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    instance_id

    是

    String

    参数解释:

    实例ID。

    可调用查询数据库实例列表接口,通过表4中的“id”获取。

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

请求消息

无。

请求示例

查询向量存储状态。

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/c90928717dc747e2a20099894a87c468in01/vector-storage

响应消息

  • 正常响应要素说明
    表2 参数说明

    参数

    参数类型

    描述

    vector_storage_switch

    Boolean

    参数解释:

    向量存储开关。

    取值范围:

    • true:表示已开启。
    • false:表示已关闭。
  • 正常响应样例
    {
       "vector_storage_switch": true
    }

状态码

错误码

请参见错误码。

相关文档