tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBusinessIntelligenceFile

Last updated: 2024-11-26 16:33:08

    1. API Description

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

    This API is used to query the files required by business intelligence service.

    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: DescribeBusinessIntelligenceFile.
    Version Yes String Common Params. The value used for this API: 2018-03-28.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID
    FileName No String File name
    StatusSet.N No Array of Integer Migration task status set. Valid values: 1 (Initialize to be deployed), 2 (Deploying), 3 (Deployment successful), 4 (Deployment failed)
    FileType No String File type. Valid values: FLAT (flat files), SSIS (project file for business intelligence service).
    Limit No Integer The maximum number of results returned per page. Value range: 1-100.
    Offset No Integer Page number. Default value: 0.
    OrderBy No String Sorting field. Valid values: file_name, create_time, start_time.
    OrderByType No String Sorting order: Valid values: desc, asc.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of file deployment tasks
    BackupMigrationSet Array of BusinessIntelligenceFile File deployment task set
    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 Querying the files required by business intelligence service

    Input Example

    POST / HTTP/1.1
Host: sqlserver.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBusinessIntelligenceFile
<Common request parameters>

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

    Output Example

    {
    "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. 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
    FailedOperation.DBError Database error.
    InternalError.SystemError System error.
    InvalidParameter.InputIllegal Input error.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy