ListRecords - Edge Security Acceleration - Centre de documentation Alibaba Cloud

Consulte la liste des enregistrements DNS d'un site, y compris les valeurs d'enregistrement, les priorités, les configurations d'authentification, etc. Prend en charge le filtrage par conditions telles que le nom de l'enregistrement et le type d'enregistrement.

Description de l'opération

Les enregistrements DNS correspondant aux conteneurs edge, aux fonctions edge et à l'accélération de couche 4 ne seront pas renvoyés par cette API.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

esa:ListRecords

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
SiteId	integer	Oui	L'identifiant du site, qui peut être obtenu en appelant l'API ListSites.	1234567890123
RecordName	string	Non	Le nom de l'enregistrement. Utilisé comme condition de filtrage pour les requêtes.	www.example.com
RecordMatchType	string	Non	Le mode de correspondance de recherche pour les noms d'enregistrement. La valeur par défaut est la correspondance exacte. Valeurs valides :	fuzzy
PageNumber	integer	Non	Le numéro de page pour les requêtes paginées. La valeur doit être supérieure ou égale à 1. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page pour les requêtes paginées. Valeurs valides : 1 à 500. Valeur par défaut : 500.	10
SourceType	string	Non	Le type d'origine de l'enregistrement. Utilisé comme condition de filtrage pour les requêtes (seuls les enregistrements CNAME peuvent être filtrés par ce champ). Valeurs valides :	OSS
BizName	string	Non	Le scénario métier pour l'accélération de l'enregistrement. Utilisé comme condition de filtrage pour les requêtes. Valeurs valides :	web
Proxied	boolean	Non	Indique si l'accélération par proxy est activée pour l'enregistrement. Utilisé comme condition de filtrage pour les requêtes. Valeurs valides :	true
Type	string	Non	Le type d'enregistrement DNS de l'enregistrement. Utilisé comme condition de filtrage pour les requêtes.	CNAME

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	15C66C7B-671A-4297-9187-2C4477247A74
PageNumber	integer	Le numéro de page actuel, identique au paramètre de requête PageNumber.	1
PageSize	integer	Le nombre d'enregistrements affichés par page.	10
TotalCount	integer	Le nombre total d'enregistrements.	20
Records	array<object>	Les informations DNS des enregistrements. Pour plus de détails, consultez la Documentation.
	array<object>	Les informations sur un enregistrement unique.
BizName	string	Le scénario métier pour l'accélération de l'enregistrement. Valeurs valides :	web
Data	object	Les informations DNS spécifiques de l'enregistrement. Différents types d'enregistrement contiennent différentes informations.	{"value":"1.1.1.1"}
Value	string	The record value or partial content. This parameter is included in A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records. It has different meanings for different record types: A/AAAA: The IP address pointed to. When there are multiple IPs, they are separated by commas (,). At least one IPv4 address is required. CNAME: The target domain name pointed to. NS: The name server for the specified domain. MX: A valid target mail server domain name. TXT: A valid text string. CAA: A valid certificate authority domain name. SRV: A valid target host domain name. URI: A valid URI string.	CNAME
Priority	integer	The priority of the record. Valid values: 0 to 65535. A smaller value indicates a higher priority. Exclusive to MX, SRV, and URI records.	0
Flag	integer	The flag of the record. The Flag of a CAA record indicates its priority and processing method. Valid values: 0 to 255. Exclusive to CAA records.	128
Tags	object	The tags of the record.	{\"Name\":\"PARAMETER\"}
Weight	integer	The weight of the record. Valid values: 0 to 65535. Exclusive to SRV and URI records.	0
Port	integer	The port of the record. Valid values: 0 to 65535. Exclusive to SRV records.	80
Type	integer	The certificate type of the record (in CERT records), or the public key type (in SSHFP records).	0
KeyTag	integer	The public key identifier of the record. Valid values: 0 to 65535. Exclusive to CERT records.	0
Algorithm	integer	The encryption algorithm used by the record. Valid values: 0 to 255. Exclusive to CERT and SSHFP records.	0
Certificate	string	The public key certificate information of the record. Exclusive to CERT, SMIMEA, and TLSA records.	dGVzdGFkYWxrcw==
Usage	integer	The usage identifier of the record. Valid values: 0 to 255. Exclusive to SMIMEA and TLSA records.	0
Selector	integer	The type of certificate or public key used by the record. Valid values: 0 to 255. Exclusive to SMIMEA and TLSA records.	0
MatchingType	integer	The algorithm strategy used by the record for matching or verifying certificates. Valid values: 0 to 255. Exclusive to SMIMEA and TLSA records.	0
Fingerprint	string	The public key fingerprint value of the record. Exclusive to SSHFP records.	abcdef1234567890
Tag	string	The tag of the record. The Tag of a CAA record indicates its specific type and purpose. Exclusive to CAA records.	issue
CreateTime	string	L'heure de création de l'enregistrement. Le format de date suit la norme ISO 8601 et utilise l'heure UTC au format yyyy-MM-ddTHH:mm:ssZ.	2023-12-24T02:01:11Z
UpdateTime	string	L'heure de mise à jour de l'enregistrement. Le format de date suit la norme ISO 8601 et utilise l'heure UTC au format yyyy-MM-ddTHH:mm:ssZ.	2023-06-07T10:02:59Z
Proxied	boolean	Indique si l'accélération par proxy est activée pour l'enregistrement. Valeurs valides :	true
RecordId	integer	L'identifiant de l'enregistrement.	1234567890123
RecordSourceType	string	Le type d'origine de l'enregistrement CNAME. Ce paramètre est requis lors de l'ajout d'un enregistrement CNAME. Valeurs valides :	OSS
RecordName	string	Le nom de l'enregistrement.	a.example.com
RecordType	string	Le type DNS de l'enregistrement, tel que A/AAAA, CNAME, TXT, etc.	A/AAAA
SiteId	integer	L'identifiant du site auquel l'enregistrement appartient.	1234567890123
SiteName	string	Le nom du site auquel l'enregistrement appartient.	example.com
Ttl	integer	Le TTL (Time to Live) de l'enregistrement, en secondes. Lorsque la valeur est 1, cela indique que le TTL est défini sur automatique.	30
RecordCname	string	Le CNAME de l'enregistrement. Il s'agit de la valeur CNAME qui doit être configurée pour l'enregistrement lorsque la méthode d'accès au site est l'accès CNAME.	a.example.com.cnamezone.com
Comment	string	Le commentaire de l'enregistrement.	Ceci est une remarque
AuthConf	object	Les informations d'authentification d'origine de l'enregistrement CNAME.
AuthType	string	The origin authentication type. Different origin types support different authentication types. The origin type refers to the SourceType parameter in this API. When the origin type is OSS or S3, the origin authentication type must be specified. Valid values: public: Public read. Use this value when the origin type is OSS or S3 and the origin has public read access. private: Private read. Use this value when the origin type is S3 and the origin has private read access. private_same_account: Private same-account read. Use this value when the origin type is OSS, the origin is under the same Alibaba Cloud account, and the origin has private read access. private_cross_account: Private cross-account read. Use this value when the origin type is OSS, the origin is not under the same Alibaba Cloud account, and the origin has private read access.	private
AccessKey	string	The AccessKey of the account to which the origin belongs. This parameter is available when the origin type is OSS with private cross-account read authentication, or when the origin type is S3 with private read authentication.	u0Nkg5gBK***QF5wvKMM504JUHt
SecretKey	string	The SecretKey of the account to which the origin belongs. This parameter is available when the origin type is OSS with private cross-account read authentication, or when the origin type is S3 with private read authentication.	VIxuvJSA2S03f***kp208dy5w7
Version	string	The signature algorithm version. This parameter is available when the origin type is S3 and the origin authentication type is private read. Valid values: v2 v4 Default value: v4.	v4
Region	string	The region where the origin is located. This parameter is available when the origin type is S3. The region of the origin can be obtained from the official S3 website.	us-east-1
HostPolicy	string	La stratégie d'hôte d'origine. Celle-ci prend effet lorsque le type d'enregistrement est CNAME. Elle définit la stratégie pour l'en-tête d'hôte utilisé lors des requêtes d'origine. Deux modes sont disponibles :	follow_origin_domain

Exemples

JSON format

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 20,
  "Records": [
    {
      "BizName": "web",
      "Data": {
        "Value": "CNAME",
        "Priority": 0,
        "Flag": 128,
        "Tags": {
          "test": "test",
          "test2": 1
        },
        "Weight": 0,
        "Port": 80,
        "Type": 0,
        "KeyTag": 0,
        "Algorithm": 0,
        "Certificate": "dGVzdGFkYWxrcw==",
        "Usage": 0,
        "Selector": 0,
        "MatchingType": 0,
        "Fingerprint": "abcdef1234567890",
        "Tag": "issue"
      },
      "CreateTime": "2023-12-24T02:01:11Z",
      "UpdateTime": "2023-06-07T10:02:59Z",
      "Proxied": true,
      "RecordId": 1234567890123,
      "RecordSourceType": "OSS",
      "RecordName": "a.example.com",
      "RecordType": "A/AAAA",
      "SiteId": 1234567890123,
      "SiteName": "example.com",
      "Ttl": 30,
      "RecordCname": "a.example.com.cnamezone.com",
      "Comment": "this is a remark.",
      "AuthConf": {
        "AuthType": "private",
        "AccessKey": "u0Nkg5gBK***QF5wvKMM504JUHt",
        "SecretKey": "VIxuvJSA2S03f***kp208dy5w7",
        "Version": "v4",
        "Region": "us-east-1"
      },
      "HostPolicy": "follow_origin_domain"
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.