API 中心
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > API 中心 > 数据安全治理中心 > 数据资产管理相关接口 > 拉取用户COS元数据信息

拉取用户COS元数据信息

最近更新时间：2024-03-12 01:27:23

我的收藏

本页目录：

1. 接口描述

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

本接口用于获取COS元数据信息，返回COS元数据信息列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ListDSPACosMetaResources。
Version 是 String 公共参数，本接口取值：2019-07-23。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-singapore 。
DspaId 是 String 实例Id
示例值：dspa-xxxxxxxx
Filters.N 否 Array of DspaDataSourceMngFilter 过滤数组。支持的Name：
Bucket - 桶名，支持模糊匹配

ResoureRegion - 资源所处地域，需要填写完整地域名称，不支持模糊匹配。

Valid -- 资源是否有效，"1" 表示有效，"0"表示无效。
Offset 否 Integer 偏移量，默认为0。
示例值：0
Limit 否 Integer 返回数量，默认为100。
示例值：100
BindType 否 String 资源绑定状态过滤，默认为全部
示例值：binded

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的COS元数据数量。
示例值：1
Items Array of DSPACosMetaDataInfo COS元数据信息
注意：此字段可能返回 null，表示取不到有效值。
DspaId String DSPA实例ID
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

获取dspa实例下的cos资源列表

输入示例

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

{
    "DspaId": "abc",
    "Filters": [
        {
            "Name": "abc",
            "Values": [
                "abc"
            ]
        }
    ],
    "Offset": 1,
    "Limit": 1,
    "BindType": "abc"
}

输出示例

{
    "Response": {
        "TotalCount": 0,
        "Items": [
            {
                "Bucket": "abc",
                "CreateTime": "abc",
                "Valid": 0,
                "ResourceId": "abc",
                "ResourceRegion": "abc",
                "BindStatus": "abc",
                "Storage": 1
            }
        ],
        "DspaId": "abc",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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