DescribeBatchResultDetail - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the detailed results of a batch operation task.

Operation description

Before you call this operation, make sure that the batch operation task is complete.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
alidns:DescribeBatchResultDetail	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language.	en
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page.	20
TaskId	long	No	The ID of the batch operation task.	83618818
BatchType	string	No	The type of the batch operation. Valid values: DOMAIN_ADD: adds domain names in batches. DOMAIN_DEL: deletes domain names in batches. RR_ADD: adds Domain Name System (DNS) records in batches. RR_DEL: deletes DNS records in batches.	DOMAIN_ADD
Status	string	No	The execution result. If you do not specify this parameter, all results are returned.	SUCCESS

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of entries returned.	1
BatchResultDetails	array<object>	The detailed results of the batch operation.
BatchResultDetail	object
Status	boolean	The execution result of the batch operation. Valid values: true: The operation succeeded. false: The operation failed.	true
Type	string	The type of the DNS record.	A
Domain	string	The domain name.	example.com
Remark	string	The description of the DNS record.	remark
RecordId	string	The ID of the DNS record.	123456789
Rr	string	The hostname.	www
Priority	string	The priority of the mail exchanger (MX) record.	10
RrStatus	string	The status of the DNS record.	stop
OperateDateStr	string	The time when the operation was performed. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.	2019-08-22 18:02:58
NewValue	string	The new record value.	192.0.2.254
Value	string	The record value.	192.0.2.0
Ttl	string	The time-to-live (TTL) of the DNS record.	600
BatchType	string	The type of the batch operation.	DOMAIN_ADD
Line	string	The line code.	default
NewRr	string	The new hostname.	demo-batch-7
Reason	string	The cause of the execution failure.	Task lock fail
PageSize	long	The number of entries per page.	10
RequestId	string	The request ID.	75446CC1-FC9A-4595-8D96-089D73D7A63D
PageNumber	long	The page number.	1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "BatchResultDetails": {
    "BatchResultDetail": [
      {
        "Status": true,
        "Type": "A",
        "Domain": "example.com",
        "Remark": "remark",
        "RecordId": "123456789",
        "Rr": "www",
        "Priority": "10",
        "RrStatus": "stop",
        "OperateDateStr": "2019-08-22 18:02:58",
        "NewValue": "192.0.2.254",
        "Value": "192.0.2.0",
        "Ttl": "600",
        "BatchType": "DOMAIN_ADD",
        "Line": "default",
        "NewRr": "demo-batch-7",
        "Reason": "Task lock fail"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "75446CC1-FC9A-4595-8D96-089D73D7A63D",
  "PageNumber": 1
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history