管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>云点播>云点播 API 2024-07-18>存储相关接口>查询专业版应用存储

查询专业版应用存储

最近更新时间：2025-04-25 02:09:47

我的收藏

本页目录：

1. 接口描述

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

该接口用于查询专业版应用中的存储桶信息，同时支持分页查询。

注：

  • 本接口仅用于专业版应用。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeStorage。
Version 是 String 公共参数，本接口取值：2024-07-18。
Region 否 String 公共参数，此参数为可选参数。
SubAppId 是 Integer 点播专业版应用 ID。
示例值：1020304056
Filters.N 否 Array of Filter 过滤条件，Filters.Values 的上限为 20；若 Filters 长度为 0 则分页查询子应用 SubAppId 下的存储信息。 详细的过滤条件如下：
  • BucketId
       按照【存储桶 ID】进行过滤。
       类型：String
       必选：否
  • StorageName
       按照【存储名称】进行过滤。
       类型：String
       必选：否
    		•
    SortBy 否 SortBy 返回结果的排序。 SortBy.Field 取值有：
  • CreateTime：创建时间。
    • 若不填，SortBy.Field 默认值为 CreateTime，SortBy.Order 默认值为 Asc。
    Offset 否 Integer 分页返回的起始偏移量，默认值为 0。
    示例值：0
    Limit 否 Integer 分页返回的记录条数，默认值为 20，最大值为 1000。
    示例值：20

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的存储数量。
    示例值：1
    StorageInfoSet Array of StorageInfo 符合条件的存储信息列表。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 分页查询专业版应用存储信息

    按照创建时间倒序，分页查询专业版应用的存储信息。

    输入示例

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

{
    "SubAppId": 1020304056,
    "SortBy": {
        "Field": "CreateTime",
        "Order": "Desc"
    },
    "Offset": 0,
    "Limit": 20
}

    输出示例

    {
    "Response": {
        "TotalCount": 2,
        "StorageInfoSet": [
            {
                "BucketId": "bucketId123demo",
                "CreateTime": "2024-07-18T00:00:00+00:00",
                "InternetAccessDomain": "example123.vodpro.ap-guangzhou.eovod.com",
                "InternetAccessDomainStatus": "DEPLOYING",
                "StorageName": "my-storage",
                "StorageRegion": "ap-guangzhou"
            },
            {
                "BucketId": "bucketId456demo",
                "CreateTime": "2024-07-17T00:00:00+00:00",
                "InternetAccessDomain": "example456.vodpro.ap-guangzhou.eovod.com",
                "InternetAccessDomainStatus": "ONLINE",
                "StorageName": "my-storage2",
                "StorageRegion": "ap-shanghai"
            }
        ],
        "RequestId": "af4b9a1e-8df1-demo-reqid-ac6364f13e69"
    }
}

    示例2 按照存储桶 ID 查询专业版应用的存储信息

    添加查询过滤器 Filter，按照存储桶 ID 过滤查询存储桶信息。

    输入示例

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

{
    "SubAppId": 1020304056,
    "Filters": [
        {
            "Name": "BucketId",
            "Values": [
                "bucketId123demo"
            ]
        }
    ]
}

    输出示例

    {
    "Response": {
        "TotalCount": 1,
        "StorageInfoSet": [
            {
                "BucketId": "bucketId123demo",
                "CreateTime": "2024-07-18T00:00:00+00:00",
                "InternetAccessDomain": "example123.vodpro.ap-guangzhou.eovod.com",
                "InternetAccessDomainStatus": "DEPLOYING",
                "StorageName": "my-storage",
                "StorageRegion": "ap-guangzhou"
            }
        ],
        "RequestId": "bf5c72d0-5b34-demo-reqid-4b5a2d7b4c68"
    }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidFilter 无效的过滤器
    InvalidParameter 参数错误。
    InvalidParameterValue 参数取值错误。
    中国站
    目录