腾讯健康组学平台查询缓存卷列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： omics.tencentcloudapi.com 。

查询缓存卷列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeVolumes。
Version	是	String	公共参数，本接口取值：2022-11-28。
Region	是	String	公共参数，详见产品支持的地域列表。
EnvironmentId	是	String	环境ID。示例值：env-dus7da1
Limit	否	Integer	返回数量，默认为20，最大值为100。示例值：10
Offset	否	Integer	偏移量，默认为0。示例值：0
Filters.N	否	Array of Filter	过滤器，支持过滤字段： - Name：名称 - IsDefault：是否为默认示例值：{"IsDefault": ["true"]}

3. 输出参数

参数名称	类型	描述
Volumes	Array of Volume	缓存卷。示例值：[{"VolumeId": "vol-4kmq63d5","Name": "默认缓存卷（env-5ehsk9fq）","EnvironmentInfo": {"EnvironmentId": "env-5ehsk9fq","Name": "测试","Managed": false},"Type": "SHARED","Spec": "HP","Capacity": 32768,"Usage": 135125794816,"BandwidthLimit": 220,"DefaultMountPath": "/vol-4kmq63d5","IsDefault": true,"Region": "ap-guangzhou"}]
TotalCount	Integer	符合条件的数量。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询缓存卷列表

查询缓存卷列表。

输入示例

POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVolumes
<公共请求参数>

{
    "EnvironmentId": "menv-ry46eloh"
}

输出示例

{
    "Response": {
        "RequestId": "f5020059-1511-4f45-ab7e-5188a78bda4b",
        "TotalCount": 1,
        "Volumes": [
            {
                "BandwidthLimit": 380,
                "Capacity": 32768,
                "DefaultMountPath": "/vol-8w7rfq4b",
                "Description": "",
                "EnvironmentId": "menv-ry46eloh",
                "IsDefault": true,
                "Name": "默认缓存卷（menv-ry46eloh）",
                "Spec": "HP",
                "Status": "AVAILABLE",
                "Type": "SHARED",
                "Usage": 973150879744,
                "VolumeId": "vol-8w7rfq4b"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
LimitExceeded	超过配额限制。
OperationDenied	操作被拒绝。
ResourceNotFound	资源不存在。

查询缓存卷列表

本页目录：