tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateFileExportUserJob

Last updated: 2024-11-13 19:47:15

    1. API Description

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

    This API is used to create a file for user export task.

    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: CreateFileExportUserJob.
    Version Yes String Common Params. The value used for this API: 2022-03-31.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    UserStoreId Yes String User directory ID
    Format No String Exported data type

  • NDJSON
    • New-line Delimited JSON
  • CSV
    • Comma-Separated Values
    Filters.N No Array of Filter Valid values of Key: condition, userGroupId.

  • condition
    • Values = Query condition, which can be user ID, username, mobile number, or email address.
  • userGroupId
    • Values = User group ID
    ExportPropertyMaps.N No Array of ExportPropertyMap Attributes and mapping names included in the exported user information. If this parameter is empty, all attributes will be included.

    3. Output Parameters

    Parameter Name Type Description
    Job Job Data flow task
    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 file for user export task

    creating a file for user export task

    Input Example

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

{
    "UserStoreId": "2c3aca3b****************a7efe88e",
    "Format": "NDJSON",
    "Filters": [
        {
            "Key": "local",
            "Values": [
                "beijing"
            ],
            "Logic": true
        }
    ],
    "ExportPropertyMaps": [
        {
            "UserPropertyCode": "nickname",
            "ColumnName": "nickname"
        }
    ]
}

    Output Example

    {
    "Response": {
        "Job": {
            "Id": "c29f2c0f****************405ec698",
            "Status": "PENDING",
            "Type": "IMPORT_USER",
            "CreatedDate": 1715156770024,
            "Format": "NDJSON",
            "Location": "http://aa.com/bb.csv",
            "ErrorDetails": [
                {
                    "UserId": "53e25c3****************e4eb5bd1",
                    "Error": "error message"
                }
            ],
            "FailedUsers": [
                {
                    "FailedUserIdentification": "53e25c3****************e4eb5bd1",
                    "FailedReason": "error reason"
                }
            ]
        },
        "RequestId": "e2e9e8aa********************9ab34c6e"
    }
}

    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
    AuthFailure A CAM signature/authentication error occurred.
    DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
    FailedOperation The operation failed.
    FailedOperation.DataFlowTooManyRequests There are already two valid tasks. Wait for one of them to complete and try again.
    FailedOperation.ImportUserIsEmpty The user is empty during user import.
    FailedOperation.InvalidTenant The tenant is invalid.
    FailedOperation.InvalidUserStore The user pool is invalid.
    FailedOperation.QuotaLimitExceeded The quota is exceeded. Contact customer service.
    InternalError An internal error occurred.
    InternalError.UnknownError An unknown error occurred.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.ParameterIllegal The request parameter is invalid.
    InvalidParameterValue The parameter value is incorrect.
    LimitExceeded The quota limit is exceeded.
    MissingParameter The parameter is missing.
    OperationDenied The operation was denied.
    RequestLimitExceeded The number of requests exceeds the frequency limit.
    RequestLimitExceeded.FrequentRequest Too many requests. Try again later.
    RequestLimitExceeded.RepeatRequest Repeated request. Try again later.
    ResourceInUse The resource is in use.
    ResourceInsufficient The resource is insufficient.
    ResourceNotFound The resource does not exist.
    ResourceUnavailable The resource is unavailable.
    ResourcesSoldOut The resources have been sold out.
    UnauthorizedOperation The operation is unauthorized.
    UnauthorizedOperation.TenantNotActivated The service is not activated.
    UnknownParameter The parameter is unknown.
    UnsupportedOperation The operation is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy