tencent cloud

Feedback

CreateExportComplianceStatusListJob

Last updated: 2024-07-22 11:03:37

    1. API Description

    Domain name for API request: tcss.tencentcloudapi.com.

    This API is used to create a task to export security compliance information.

    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: CreateExportComplianceStatusListJob.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    AssetType Yes String Asset type of the information to be exported
    ExportByAsset Yes Boolean Export by check item or asset. Valid values: true (export by asset); false (export by check item).
    ExportAll Yes Boolean Valid values: true (export all); false (export based on the IdList).
    IdList.N No Array of Integer List of IDs of assets or check items to be exported, which is determined by the value of ExportByAsset.

    3. Output Parameters

    Parameter Name Type Description
    JobId String ID of the created export task
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Creating a task to export security compliance information

    Input Example

    POST / HTTP/1.1
    Host: tcss.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateExportComplianceStatusListJob
    <Common request parameters>
    
    {
        "AssetType": "ASSET_CONTAINER",
        "ExportByAsset": false,
        "ExportAll": true
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "xxxxx",
            "JobId": "xxxx"
        }
    }
    

    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 The operation failed.
    InvalidParameter The parameter is incorrect.
    InvalidParameterValue The parameter value is incorrect.
    InvalidParameterValue.DataNotFound The current data was not found.
    LimitExceeded The quota limit has been reached.
    OperationDenied The operation was denied.
    RequestLimitExceeded The number of requests exceeds the frequency limit.