All Products
Search

This Product

    Direct Mail:GetValidateFileStatus

    Document Center

    Direct Mail:GetValidateFileStatus

    Last Updated:Mar 31, 2026

    Retrieves the status of a file validation task.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dm:GetValidateFileStatus

    get

    *All Resource

    *

    		 None None

    Request syntax

    GET  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    FileId

    string

    Yes

    The file ID returned after you submit the file for validation.

    xxxx-xxxx-xxxx-xxxx

    Response elements

    Element

    Type

    Description

    Example

    object

    The response object.

    RequestId

    string

    The request ID.

    yyyy-yyyy-yyyy-yyyy
    FileName

    string

    The file name.

    file.txt
    UploadTime

    string

    The upload time.

    2000-01-01T00:00:00Z
    Status

    string

    The task status.

    Valid values:

    • deleted :

      The task was deleted.

    • processing :

      The task is processing.

    • completed :

      The task is complete.

    completed
    Percentage

    string

    The task completion percentage.

    100%
    CompleteTime

    string

    The task completion time.

    2000-01-01T00:00:00Z
    TotalNum

    string

    The total number of addresses in the file.

    10
    ProcessedNum

    string

    The number of processed addresses.

    10
    ValidNum

    string

    The number of valid addresses.

    4
    InvalidNum

    string

    The number of invalid addresses.

    2
    CatchAllNum

    string

    The number of catch-all addresses.

    2
    DoNotMailNum

    string

    The number of do-not-mail addresses.

    1
    UnknownNum

    string

    The number of unknown addresses.

    1
    FileId

    string

    The file ID.

    xxxx-xxxx-xxxx-xxxx

    Examples

    Success response

    JSON format

    {
  "RequestId": "yyyy-yyyy-yyyy-yyyy",
  "FileName": "file.txt",
  "UploadTime": "2000-01-01T00:00:00Z",
  "Status": "completed",
  "Percentage": "100%",
  "CompleteTime": "2000-01-01T00:00:00Z",
  "TotalNum": "10",
  "ProcessedNum": "10",
  "ValidNum": "4",
  "InvalidNum": "2",
  "CatchAllNum": "2",
  "DoNotMailNum": "1",
  "UnknownNum": "1",
  "FileId": "xxxx-xxxx-xxxx-xxxx"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.