DescribeBatchResultCount - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

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

alidns:DescribeBatchResultCount

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. Default value: zh. Valid values: zh: Chinese en: English	en
TaskId	integer	No	The task ID. Note If you specify a task ID, the results of that task are returned. If you leave this parameter empty, the results of the most recent task are returned.	1****
BatchType	string	No	The type of the batch operation. Valid values: DOMAIN_ADD: Batch add domain names. DOMAIN_DEL: Batch delete domain names. RR_ADD: Batch add DNS records. RR_DEL: Batch delete DNS records. Note If you leave this parameter empty, no filter is applied.	DOMAIN_ADD

Response elements

Element	Type	Description	Example
	object
Status	integer	The status of the task. Valid values: -1: No task was submitted to import domain names or DNS records. 0: Processing 1: Completed 2: Failed	0
TotalCount	integer	The total number of records that are processed in batches.	4
TaskId	integer	The ID of the last task.	1******
RequestId	string	The request ID.	75446CC1-FC9A-4595-8D96-089D73D7A63D
FailedCount	integer	The total number of domain names or DNS records that failed to be processed.	2
SuccessCount	integer	The total number of domain names or DNS records that were successfully processed.	2
BatchType	string	The type of the batch operation.	DOMAIN_ADD
Reason	string	The reason why the task failed.	No match is found for the domain name specified in the file.

Examples

Success response

JSON format

{
  "Status": 0,
  "TotalCount": 4,
  "TaskId": 0,
  "RequestId": "75446CC1-FC9A-4595-8D96-089D73D7A63D",
  "FailedCount": 2,
  "SuccessCount": 2,
  "BatchType": "DOMAIN_ADD",
  "Reason": "No match is found for the domain name specified in the file."
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.