tencent cloud

DescribeStorage
Last updated: 2025-10-30 22:08:09
DescribeStorage
Last updated: 2025-10-30 22:08:09

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to query bucket information in the professional application, and it also supports paginated queries.
Note:

  • This API is exclusively for use in the professional application.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeStorage.
Version Yes String Common Params. The value used for this API: 2024-07-18.
Region No String Common Params. This parameter is not required.
SubAppId Yes Integer The ID of VOD Professional Application.
Filters.N No Array of Filter Filter criteria. The maximum number of Filters.Values is 20. If this parameter is not input, all storage under the current SubAppId will be returned. The detailed filter criteria are as follows:
  • BucketId: Filter by the ID of bucket;
  • StorageName: Filter by the name of storage.
    		•
    SortBy No SortBy Sort the returned results according to this field.
    SortBy.Field Values include:
  • UpdateTime: (Default) Create time of the storage.
    • SortBy.Order Values include:
  • Asc: (Default) The order is ascend.

    		•
    Offset No Integer Offset for paginated queries. Default value: 0.
    Limit No Integer Limit on paginated queries. Default value: 20. Maximum value: 1000.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total count of matched storage.
    StorageInfoSet Array of StorageInfo Information of all matched storage.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Paginated query for storage information in the Pro version application.

    Paginated query for storage information in the Pro version application, sorted in descending order by creation time.

    Input Example

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

    Output Example

    {
    "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"
    }
}

    Example2 Query storage information in the application by the ID of bucket.

    Add a query filter to query bucket information filtered by the ID of bucket.

    Input Example

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

    Output Example

    {
    "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. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError Internal error.
    InvalidFilter Invalid filter.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Incorrect parameter value.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback