GetValidateFileStatus - Direct Mail - Alibaba Cloud Documentation Center

Retrieves the status of a validation file.

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

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
FileId	string	Yes	The file ID returned after the task is submitted.	xxxx-xxxx-xxxx-xxxx

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	yyyy-yyyy-yyyy-yyyy
FileName	string	The name of the file that was uploaded when the task was submitted.	file.txt
UploadTime	string	The time when the file was submitted.	2000-01-01T00:00:00Z
Status	string	The task status. Valid values: deleted : The task was deleted. processing : The task is being processed. completed : The task is complete.	completed
Percentage	string	The progress of the task execution.	100%
CompleteTime	string	The time when the task was completed.	2000-01-01T00:00:00Z
TotalNum	string	The total number of email addresses to validate.	10
ProcessedNum	string	The number of email addresses that have been validated.	10
ValidNum	string	The number of email addresses with the validation result `Valid`.	4
InvalidNum	string	The number of email addresses with the validation result `Invalid`.	2
CatchAllNum	string	The number of email addresses with the validation result `CatchAll`.	2
DoNotMailNum	string	The number of email addresses with the validation result `DoNotMail`.	1
UnknownNum	string	The number of email addresses with the validation result `Unknown`.	1
FileId	string

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": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.