ListCertificatesByRecord - Edge Security Acceleration - Centre de documentation Alibaba Cloud

Consulte la liste des certificats de site correspondant aux enregistrements. La correspondance par lot des enregistrements est prise en charge.

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

none

*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. Vous pouvez appeler l'opération ListSites pour obtenir l'identifiant du site.	1234567890123
RecordName	string	Oui	Le nom de l'enregistrement.	www.example.com
ValidOnly	boolean	Non	Indique si seuls les certificats valides doivent être renvoyés.	true
Detail	boolean	Non	Indique si les détails du certificat doivent être renvoyés.	true

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
RequestId	string	L'identifiant de la requête.	65C66B7B-671A-8297-9187-2R5477247B76
TotalCount	integer	Le nombre total d'entrées, qui est identique au nombre d'enregistrements.	12
SiteId	integer	L'identifiant du site.	1234567890123
SiteName	string	Le nom du site.	example.com
Result	array<object>	Le tableau de résultats.
	array<object>	Le résultat.
RecordName	string	Le nom de l'enregistrement.	www.example.com
Count	integer	Le nombre de certificats correspondant à l'enregistrement.	3
Certificates	array<object>	La liste des certificats correspondant à l'enregistrement.
	object	Les informations du certificat.
CasId	string	The cloud certificate ID.	30000137
Id	string	The certificate ID.	babab022c5e9b27bf9c64d7f4b1667f4
Name	string	The certificate name.	yourCertName
Region	string	The certificate store area.	cn-hangzhou
Status	string	The certificate status.	OK
Type	string	The certificate type. Valeurs valides : cas : SSL Certificates Service certificate. upload : custom uploaded certificate. keyless : Keyless certificate. free : free certificate.	free
CommonName	string	The common name of the certificate.	www.example.com
NotBefore	string	The start time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.	2023-02-28 06:17:11
NotAfter	string	The end time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.	2024-02-28 06:17:11
Issuer	string	The certificate issuer.	GlobalSign nv-sa
IssuerCN	string	The common name of the certificate issuer.	GlobalSign Organization Validation CA - SHA256 - G3
SAN	string	The Subject Alternative Name (SAN) of the certificate.	www.example.com,*.example.com
SigAlg	string	The signature algorithm of the certificate.	SHA256-RSA
PubAlg	string	The public key algorithm of the certificate.	RSA
CreateTime	string	The creation time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.	2023-02-28 06:17:11
UpdateTime	string	The update time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.	2023-02-28 06:17:11
SerialNumber	string	The certificate serial number.	baba39055622c008b90285a8838ed09a
FingerprintSha256	string	The SHA-256 fingerprint of the certificate.	1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66
KeyServerId	string	The Keyless server ID. This parameter is valid only when Type is set to keyless.	baba39055622c008b90285a8838e****
ApplylingCount	integer	Le nombre de certificats en cours de demande.	1
Status	string	L'état de la configuration du certificat de l'enregistrement. Valeurs valides : none : Non configuré. configured : Configuré. applying : En cours de demande. failed : Échec de la demande. Valeurs valides : configured : Configuré. applying : En cours de demande. none : Non configuré. failed : Échec de la demande.	none

Exemples

JSON format

{
  "RequestId": "65C66B7B-671A-8297-9187-2R5477247B76",
  "TotalCount": 12,
  "SiteId": 1234567890123,
  "SiteName": "example.com ",
  "Result": [
    {
      "RecordName": "www.example.com ",
      "Count": 3,
      "Certificates": [
        {
          "CasId": "30000137",
          "Id": "babab022c5e9b27bf9c64d7f4b1667f4",
          "Name": "yourCertName",
          "Region": "cn-hangzhou",
          "Status": "OK",
          "Type": "free",
          "CommonName": "www.example.com ",
          "NotBefore": "2023-02-28 06:17:11",
          "NotAfter": "2024-02-28 06:17:11",
          "Issuer": "GlobalSign nv-sa",
          "IssuerCN": "GlobalSign Organization Validation CA - SHA256 - G3",
          "SAN": "www.example.com,*.example.com",
          "SigAlg": "SHA256-RSA",
          "PubAlg": "RSA",
          "CreateTime": "2023-02-28 06:17:11",
          "UpdateTime": "2023-02-28 06:17:11",
          "SerialNumber": "baba39055622c008b90285a8838ed09a",
          "FingerprintSha256": "1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66",
          "KeyServerId": "baba39055622c008b90285a8838e****\n"
        }
      ],
      "ApplylingCount": 1,
      "Status": "none"
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParameter.SiteId	Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.	Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.
400	MissingSiteId	Required parameter SiteId missing. Specify SiteId and try again.	Required parameter SiteId missing. Specify SiteId and try again.
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.
400	MissingParameter	Required parameter RecordName missing. Specify RecordName and try again.	Required parameter RecordName missing. Specify RecordName and try again.
403	Unauthorized.InvalidTime	The specified authentication time is invalid.	The authentication time parameter you entered is invalid. Check the parameter value and try again.
403	Unauthorized.InvalidToken	Token authentication failed.	The token you entered is invalid. Please check and enter the correct token and try again.

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

Notes de version

Consultez Notes de version pour la liste complète.