list_records
Query and filter DNS records of a website using site ID, record name, match type, and other parameters to retrieve details like value, priority, and authentication configurations.
Instructions
Queries a list of Domain Name System (DNS) records of a website, including the record value, priority, and authentication configurations. Supports filtering by specifying parameters such as RecordName and RecordMatchType.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bizName | No | The business scenario of the record for acceleration. Valid values: image_video: video and image. api: API.web: web page. | |
| pageNumber | No | The page number. Default value: 1. | |
| pageSize | No | The number of entries per page. Default value: 500. | |
| proxied | No | Filters by whether the record is proxied. Valid values:true, false | |
| recordMatchType | No | The match mode to search for the record name. Default value: exact. Valid values: prefix: match by prefix.suffix: match by suffix. exact: exact match. fuzzy: fuzzy match. | |
| recordName | No | The record name. This parameter specifies a filter condition for the query. | |
| siteId | Yes | The website ID, which can be obtained by calling the ListSites operation. | |
| sourceType | No | The origin type of the record. Only CNAME records can be filtered by using this field. Valid values: OSS: OSS bucket. S3: S3 bucket. LB: load balancer. OP: origin pool. Domain: domain name. | |
| type | No | The DNS record type. |
Input Schema (JSON Schema)
{
"annotations": {
"destructiveHint": false,
"idempotentHint": false,
"readOnlyHint": true
},
"properties": {
"bizName": {
"description": "The business scenario of the record for acceleration. Valid values: image_video: video and image. api: API.web: web page.",
"enum": [
"api",
"web",
"video_image"
],
"examples": [
"web"
],
"type": "string"
},
"pageNumber": {
"description": "The page number. Default value: 1.",
"examples": [
1
],
"type": "number"
},
"pageSize": {
"description": "The number of entries per page. Default value: 500.",
"examples": [
50
],
"type": "number"
},
"proxied": {
"description": "Filters by whether the record is proxied. Valid values:true, false",
"enum": [
true,
false
],
"examples": [
true
],
"type": "boolean"
},
"recordMatchType": {
"description": "The match mode to search for the record name. Default value: exact. Valid values: prefix: match by prefix.suffix: match by suffix. exact: exact match. fuzzy: fuzzy match.",
"examples": [
"fuzzy"
],
"type": "string"
},
"recordName": {
"description": "The record name. This parameter specifies a filter condition for the query.",
"examples": [
"www.example.com"
],
"type": "string"
},
"siteId": {
"description": "The website ID, which can be obtained by calling the ListSites operation.",
"examples": [
1234567890456
],
"type": "number"
},
"sourceType": {
"description": "The origin type of the record. Only CNAME records can be filtered by using this field. Valid values: OSS: OSS bucket. S3: S3 bucket. LB: load balancer. OP: origin pool. Domain: domain name.",
"enum": [
"OSS",
"S3",
"LB",
"OP",
"Domain",
"IP"
],
"examples": [
"OSS"
],
"type": "string"
},
"type": {
"description": "The DNS record type.",
"enum": [
"A/AAA",
"TXT",
"MX",
"NS",
"SRV",
"CAA",
"CERT",
"SMIMEA",
"SSHFP",
"TLSA",
"URI",
"CNAME"
],
"examples": [
"A/AAA"
],
"type": "string"
}
},
"required": [
"siteId"
],
"type": "object"
}