DescribeChangeLogs - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

You can call the DescribeChangeLogs operation to retrieve the operation logs for a private zone. The logs record operations related to built-in authoritative zones, cache management, forwarding management, endpoints, and DNS record queries. You can perform a fuzzy search by keywords such as behavior and content.

Operation description

Limits

You can query operation logs for a private zone generated within the last six months.

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

pvtz:DescribeChangeLogs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The keyword, such as a behavior or content. Fuzzy search is supported. The keyword is not case-sensitive.	test
Lang	string	No	The language of the response. Valid values: zh: Chinese. en: English. Default value: en	en
ZoneId	string	No	The ID of the zone. If you specify this parameter, the operation returns the change logs of DNS records for the specified zone. If you leave this parameter empty, the operation returns the change logs of all zones and DNS records that belong to the current account.	df2d03865266bd9842306db586d3****
PageNumber	integer	No	The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 20.	100
StartTimestamp	integer	No	The start time. This value is a UNIX timestamp.	1516779348000
EndTimestamp	integer	No	The end time. This value is a UNIX timestamp.	2516779348000
EntityType	string	No	The type of log to obtain. Valid values: PV_ZONE: operation logs of built-in authoritative zones. PV_RECORD: operation logs of DNS records. RESOLVER_RULE: operation logs of forwarding rules. CUSTOM_LINE: operation logs of custom lines. RESOLVER_ENDPOINT: operation logs of outbound endpoints. INBOUND_ENDPOINT: operation logs of inbound endpoints. CACHE_RESERVE_DOMAIN: operation logs of domains for which cache is retained. Note If you specify another value, this parameter is ignored and logs of all types are returned.	PV_ZONE
UserClientIp	string	No	The IP address of the user.	192.0.XX.XX

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	1
RequestId	string	The unique request ID.	F0FCB52A-D512-41A0-8595-40234EDCFD8B
ChangeLogs	object
ChangeLog	array<object>	The list of change logs.
	object	The details of a change log.
OperTimestamp	integer	The time when the operation was performed. This value is a UNIX timestamp.	1721619906972
EntityId	string	The unique ID of the entity, such as a domain name, custom line, forwarding rule, outbound endpoint, or inbound endpoint.	df2d03865266bd9842306db586d3****
OperObject	string	The type of the operation object. Description: PV_ZONE: a built-in authoritative zone. PV_RECORD: a DNS record. RESOLVER_RULE: a forwarding rule. CUSTOM_LINE: a custom line. RESOLVER_ENDPOINT: an outbound endpoint. INBOUND_ENDPOINT: an inbound endpoint. CACHE_RESERVE_DOMAIN: a domain for which cache is retained.	PV_RECORD
OperTime	string	The time when the operation was performed.	2024-07-22T03:45Z
OperIp	string	The IP address from which the change was initiated. This is a public IP address. If the operation was initiated from a device that uses a private IP address, this parameter indicates the public IP address of the device after Network Address Translation (NAT).	192.0.XX.XX
OperAction	string	The specific action performed on the object, such as add, delete, update, or associate.	add
Content	string	The content of the operation. This parameter records the specific details of the operation.	Add RR:test.03 Type:A Line:default TTL:300 Value:172.20.XX.XX
EntityName	string	The name of the operation object. The object can be a domain name, a custom line, a domain for which cache is retained, a forwarding rule, an outbound endpoint, or an inbound endpoint.	test.03
Id	integer	The ID of the operation record.	90761578646770****
CreatorId	string	The ID of the operator who performed the operation.	141339776561****
CreatorType	string	The type of the operator. The value can be empty or USER.	USER
CreatorSubType	string	The subtype of the operator. Valid values: CUSTOMER: an Alibaba Cloud account SUB: a RAM user STS: role assumption OTHER: other	CUSTOMER
CreatorUserId	string	The ID of the operator.	141339776561****
PageNumber	integer	The page number of the returned data.	1
TotalPages	integer	The total number of pages returned.	1
TotalItems	integer	The total number of logs.	1

Examples

Success response

JSON format

{
  "PageSize": 1,
  "RequestId": "F0FCB52A-D512-41A0-8595-40234EDCFD8B",
  "ChangeLogs": {
    "ChangeLog": [
      {
        "OperTimestamp": 1721619906972,
        "EntityId": "df2d03865266bd9842306db586d3****",
        "OperObject": "PV_RECORD",
        "OperTime": "2024-07-22T03:45Z",
        "OperIp": "192.0.XX.XX",
        "OperAction": "add",
        "Content": "Add RR:test.03 Type:A Line:default TTL:300 Value:172.20.XX.XX",
        "EntityName": "test.03",
        "Id": 0,
        "CreatorId": "141339776561****",
        "CreatorType": "USER",
        "CreatorSubType": "CUSTOMER",
        "CreatorUserId": "141339776561****"
      }
    ]
  },
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.