云压测查询文件列表-API 文档-文档中心-腾讯云

1. 接口描述

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

查询文件列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeFiles。
Version	是	String	公共参数，本接口取值：2021-07-28。
Region	否	String	公共参数，本接口不需要传递此参数。
ProjectIds.N	是	Array of String	项目 ID 数组示例值：["project-xx"]
FileIds.N	否	Array of String	文件 ID 数组示例值：["file-xx"]
FileName	否	String	文件名示例值：uin.csv
Offset	否	Integer	偏移量，默认为 0 示例值：1
Limit	否	Integer	返回数量，默认为 20，最大为 100 示例值：10
Kind	否	Integer	文件种类，参数文件-1，协议文件-2，请求文件-3 示例值：1

3. 输出参数

参数名称	类型	描述
FileSet	Array of File	文件列表注意：此字段可能返回 null，表示取不到有效值。
Total	Integer	文件总数注意：此字段可能返回 null，表示取不到有效值。示例值：10
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeFiles

输入示例

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

{
    "ProjectIds": [
        "project-xx"
    ],
    "Offset": 0,
    "FileIds": [
        "file-xx"
    ],
    "Limit": 0,
    "FileName": "file name",
    "Kind": 1
}

输出示例

{
    "Response": {
        "FileSet": [
            {
                "AppId": 1258344690,
                "Uin": "438167612",
                "SubAccountUin": "100019497941",
                "CreatedAt": "2023-04-11T15:20:18+08:00",
                "UpdatedAt": "2023-04-11T15:20:18+08:00",
                "FileId": "file-218d0901",
                "ProjectId": "project-r92xzqe3",
                "Kind": 1,
                "Name": "demo.csv",
                "Size": 18,
                "Type": "CSV",
                "Status": 2,
                "LineCount": 3,
                "HeadLines": [
                    "msg\r",
                    "world\r",
                    "pts"
                ],
                "TailLines": [],
                "HeaderInFile": true,
                "HeaderColumns": [
                    "msg"
                ],
                "FileInfos": null,
                "ScenarioSet": null,
                "AppID": 0
            }
        ],
        "RequestId": "7baba29e-5545-44e8-b39e-9be261d6369a",
        "Total": 36
    }
}

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. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。