查询商业智能服务需要的文件

最近更新时间:2024-03-12 01:47:08

我的收藏

1. 接口描述

接口请求域名: sqlserver.tencentcloudapi.com 。

本接口(DescribeBusinessIntelligenceFile)用于查询商业智能服务需要的文件。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBusinessIntelligenceFile。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
示例值:mssql-dj5i29c5n
FileName String 文件名称
示例值:file.txt
StatusSet.N Array of Integer 迁移任务状态集合,1-初始化待部署 2-部署中 3-部署成功 4-部署失败
示例值:1
FileType String 文件类型 FLAT-平面文件,SSIS商业智能服务项目文件
示例值:FLAT
Limit Integer 分页,页大小,范围1-100
示例值:10
Offset Integer 分页,页数,默认0
示例值:0
OrderBy String 排序字段,可选值file_name,create_time,start_time
示例值:file_name
OrderByType String 排序方式,desc,asc
示例值:desc

3. 输出参数

参数名称 类型 描述
TotalCount Integer 文件部署任务总数
示例值:10
BackupMigrationSet Array of BusinessIntelligenceFile 文件部署任务集合
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询商业智能服务需要的文件

输入示例

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

{
    "Offset": 0,
    "Limit": 10,
    "OrderByType": "desc",
    "OrderBy": "create_time",
    "InstanceId": "mssqlbi-fo2dwujt",
    "FileName": "test",
    "FileType": "FLAT",
    "StatusSet": [
        1
    ]
}

输出示例

{
    "Response": {
        "BackupMigrationSet": [
            {
                "Action": {
                    "AllAction": [
                        "view",
                        "remark",
                        "delete"
                    ],
                    "AllowedAction": [
                        "view",
                        "remark",
                        "delete"
                    ]
                },
                "CreateTime": "2022-08-05 14:14:17",
                "EndTime": "0000-00-00 00:00:00",
                "FileMd5": "",
                "FileName": "test.xlsx",
                "FilePath": "D:\\SSIS\\",
                "FileSize": 0,
                "FileType": "FLAT",
                "FileURL": "http://sqlserver-gz-test-1251966477.cos.ap-guangzhou.myqcloud.com/test.xlsx",
                "InstanceId": "mssqlbi-fo2dwujt",
                "Message": "",
                "Remark": "Remark",
                "StartTime": "0000-00-00 00:00:00",
                "Status": 1
            }
        ],
        "RequestId": "13903852-75f7-4977-9965-aa4babeadbd5",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DBError 数据库错误。
InternalError.SystemError 系统错误。
InvalidParameter.InputIllegal 输入错误。
ResourceNotFound.InstanceNotFound 实例不存在。
UnauthorizedOperation.PermissionDenied cam鉴权错误。