DescribeBatchResultDetail - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Retrieves the details of a batch processing result.

Operation description

Prerequisite: You can call this operation after the batch task is complete.

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:DescribeBatchResultDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the request and response. The default value is zh. Valid values: zh: Chinese en: English	en
PageNumber	integer	No	The current page number. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page.	20
TaskId	integer	No	The task ID.	8*******
BatchType	string	No	The type of the batch operation. Valid values: DOMAIN_ADD: Add domain names in batches. DOMAIN_DEL: Delete domain names in batches. RR_ADD: Add DNS records in batches. RR_DEL: Delete DNS records in batches. Note If you leave this parameter empty, the results are not filtered by operation type.	DOMAIN_ADD
Status	string	No	The status of the task. If you do not specify this parameter, the details of tasks in all states are returned.	SUCCESS

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of records.	1
BatchResultDetails	object
BatchResultDetail	array<object>	The details of the batch processing result.
	object
Status	boolean	The execution result. A value of true indicates success and a value of false indicates failure.	true
Type	string	The type of the DNS record.	A
Domain	string	The domain name.	example.com
Remark	string	The remarks for the DNS record.	remark
RecordId	string	The ID of the DNS record.	1*********
Rr	string	The host record.	www
Priority	string	The priority of the MX record.	10
RrStatus	string	The status of the DNS record.	暂停
OperateDateStr	string	The processing time.	2019-08-22 18:02:58
NewValue	string	The new record value.	192.0.2.1
Value	string	The record value.	198.51.100.1
Ttl	string	The Time to Live (TTL).	600
BatchType	string	The type of the batch operation.	DOMAIN_ADD
Line	string	The line code.	default
NewRr	string	The new host record.	demo-batch-7
Reason	string	The reason why the task failed.	内部异常
PageSize	integer	The page size.	10
RequestId	string	The request ID.	75446CC1-FC9A-4595-8D96-089D73D7A63D
PageNumber	integer	The current page number.	1

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "BatchResultDetails": {
    "BatchResultDetail": [
      {
        "Status": true,
        "Type": "A",
        "Domain": "example.com",
        "Remark": "remark",
        "RecordId": "1*********",
        "Rr": "www",
        "Priority": "10",
        "RrStatus": "暂停",
        "OperateDateStr": "2019-08-22 18:02:58",
        "NewValue": "192.0.2.1",
        "Value": "198.51.100.1",
        "Ttl": "600",
        "BatchType": "DOMAIN_ADD",
        "Line": "default",
        "NewRr": "demo-batch-7",
        "Reason": "内部异常"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "75446CC1-FC9A-4595-8D96-089D73D7A63D",
  "PageNumber": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.