DescribeAddressBook - - Centre de documentation Alibaba Cloud

Consulte les carnets d'adresses par lots.

Description de l'opération

Cette opération permet de consulter les détails des carnets d'adresses des stratégies de contrôle d'accès.

Limite de QPS

La limite de QPS par utilisateur pour cette opération est de 10 appels par seconde. Si cette limite est dépassée, les appels d'API sont limités, ce qui peut affecter votre activité. Appelez cette opération à une fréquence raisonnable.

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.

yundun-cloudfirewall:DescribeAddressBook

get

*AddressBook

acs:cloudfirewall::{#accountId}:addressbook/{#GroupUuid}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Lang	string	Non	Le type de langue pour la description du carnet d'adresses. Valeurs valides : en : anglais. zh : chinois (par défaut). Valeurs valides : en : Anglais. zh : Chinois (par défaut)	zh
CurrentPage	string	Non	Le numéro de page d'une requête paginée. Valeur par défaut : 1, ce qui indique que la première page de données est renvoyée.	1
PageSize	string	Non	Le nombre de carnets d'adresses par page dans une requête paginée. Valeur par défaut : 10, ce qui indique que chaque page contient 10 résultats. Valeur maximale : 50.	10
Query	string	Non	La condition de recherche. Saisissez les informations du carnet d'adresses que vous souhaitez consulter.	192.0.XX.XX
GroupType	string	Non	Le type du carnet d'adresses. Remarque Si vous ne définissez pas ce paramètre, les carnets d'adresses IP et les carnets d'adresses basés sur les balises ECS sont interrogés. Valeurs valides : tagPrivate : Carnet d'adresses de points de terminaison privés basés sur les étiquettes ECS. backsrcIpv6 : Carnet d'adresses de retour à l'origine IPv6. ackLabel : Carnet d'adresses d'étiquettes de pods ACK. ip : Carnet d'adresses IPv4. cloud : Carnet d'adresses cloud. cloudServiceDomain : Carnet d'adresses de noms de domaine de services cloud. backsrc : Carnet d'adresses de retour à l'origine IPv4. cloudDomain : Carnet d'adresses de noms de domaine cloud. port : Carnet d'adresses de ports. ipv6 : Carnet d'adresses IPv6. domain : Carnet d'adresses de noms de domaine. assetIpv6 : Carnet d'adresses d'actifs publics IPv6. ackNamespace : Carnet d'adresses d'espaces de noms ACK. tag : Carnet d'adresses de réseau public basé sur les balises ECS. threat : Carnet d'adresses de renseignements sur les menaces. asset : Carnet d'adresses d'actifs publics IPv4.	ip
ContainPort	string	Non	Consulte les carnets d'adresses qui contiennent le port spécifié. Ce paramètre ne prend effet que lorsque le paramètre GroupType est défini sur port.	80
GroupUuid	string	Non	L'identifiant unique du carnet d'adresses.	f04ac7ce-628b-4cb7-be61-310222b7****
AssetMemberUids	array	Non	La liste des comptes membres pour le carnet d'adresses d'actifs.
	integer	Non	La liste des comptes membres.	13580xxxxxx6271

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageNo	string	Le numéro de la page actuelle.	1
PageSize	string	Le nombre de carnets d'adresses sur chaque page.	10
RequestId	string	L'identifiant de la requête.	B36F150A-1E27-43AA-B72C-D2AC712F09DA
TotalCount	string	Le nombre total de carnets d'adresses.	100
Acls	array<object>	La liste des carnets d'adresses.
	array<object>	Les informations du carnet d'adresses.
AddressListCount	integer	Le nombre d'adresses dans le carnet d'adresses.	2
GroupUuid	string	L'identifiant unique du carnet d'adresses.	f04ac7ce-628b-4cb7-be61-310222b7****
AutoAddTagEcs	integer	Indique si les adresses IP publiques des instances ECS qui correspondent aux nouvelles balises sont automatiquement ajoutées au carnet d'adresses. Valeurs valides : 0 : Les adresses IP publiques ne sont pas ajoutées automatiquement. 1 : Les adresses IP publiques sont ajoutées automatiquement. Valeurs valides : 0 : Non ajoutées automatiquement. 1 : Ajoutées automatiquement.	1
Description	string	La description du carnet d'adresses.	DEMO
GroupName	string	Le nom du carnet d'adresses.	demo_address_book
ReferenceCount	integer	Le nombre de fois où le carnet d'adresses est référencé.	3
GroupType	string	Le type du carnet d'adresses. Valeurs valides : tagPrivate : Carnet d'adresses de points de terminaison privés basés sur les étiquettes ECS. backsrcIpv6 : Carnet d'adresses de retour à l'origine IPv6. ackLabel : Carnet d'adresses d'étiquettes de pods ACK. ip : Carnet d'adresses IPv4. cloudServiceDomain : Carnet d'adresses de noms de domaine de services cloud. cloud : Carnet d'adresses cloud. backsrc : Carnet d'adresses de retour à l'origine IPv4. cloudDomain : Carnet d'adresses de noms de domaine cloud. port : Carnet d'adresses de ports. ipv6 : Carnet d'adresses IPv6. domain : Carnet d'adresses de noms de domaine. assetIpv6 : Carnet d'adresses d'actifs publics IPv6. ackNamespace : Carnet d'adresses d'espaces de noms ACK. tag : Carnet d'adresses de réseau public basé sur les balises ECS. threat : Carnet d'adresses de renseignements sur les menaces. asset : Carnet d'adresses d'actifs publics IPv4.	ip
TagRelation	string	La relation entre plusieurs balises ECS. Valeurs valides : or : La relation entre plusieurs balises est de type OU. L'adresse IP publique d'une instance ECS qui correspond à l'une des balises est ajoutée au carnet d'adresses. and : La relation entre plusieurs balises est de type ET. L'adresse IP publique d'une instance ECS qui correspond à toutes les balises est ajoutée au carnet d'adresses. Valeurs valides : or : La relation entre plusieurs balises est OR. Les adresses IP publiques des instances Elastic Compute Service (ECS) qui correspondent à n'importe quelle balise sont ajoutées au carnet d'adresses. and : La relation entre plusieurs balises est AND. Seules les adresses IP publiques des instances Elastic Compute Service (ECS) qui correspondent à toutes les balises sont ajoutées au carnet d'adresses.	and
TagList	array<object>	La liste des balises ECS.
	object	La balise ECS.
TagValue	string	The value of the ECS tag.	ALL VALUE
TagKey	string	The key of the ECS tag.	company
AddressList	array	La liste d'adresses du carnet d'adresses.
	string	Les informations d'adresse du carnet d'adresses.	[ "192.168.XX.XX/32", "192.168.XX.XX/32" ]
Addresses	array<object>	La liste d'adresses du carnet d'adresses qui inclut des descriptions pour les adresses individuelles.
	object	L'adresse avec une description dans le carnet d'adresses.
Address	string	The address information of the address book.	192.168.0.1/32
Note	string	The description of the individual address.	Single Address Description
AckClusterConnectorId	string	L'identifiant du connecteur de cluster ACK.	ac-7c1bad6c3cc84c33baab
AckClusterConnectorName	string	Le nom du connecteur de cluster ACK.	ack-cluster-connector-name
AckLabels	array<object>	La liste des étiquettes de pod dans le cluster ACK.
	object	L'étiquette de pod dans le cluster ACK.
Key	string	The key of the pod label in the ACK cluster.	app
Value	string	The value of the pod label in the ACK cluster.	storage-operator
AckNamespaces	array	La liste des espaces de noms de pod dans le cluster ACK.
	string	L'espace de noms de pod dans le cluster ACK.	default
RegionNo	string	La région du connecteur de cluster ACK auquel le carnet d'adresses appartient lorsque GroupType est un carnet d'adresses ACK.	cn-beijing
AssetMemberUids	array	La liste des comptes membres pour le carnet d'adresses d'actifs.
	integer	La liste des comptes membres.	13580xxxxxx6271
AssetRegionResourceTypes	array<object>	La liste des régions et des types de ressources pour le carnet d'adresses des actifs.
	array<object>	La liste des régions et des types de ressources.
AssetRegionId	string	The region ID of the asset. Valeurs valides : all : All regions.	all
ResourceType	object	The asset type.
Ipv4	object	The IPv4 asset type.
SlbEIP	boolean	The asset type: SlbEIP. Valeurs valides : true : Enabled. false : Disabled.	true
NatPublicIP	boolean	The asset type: NatPublicIP. Valeurs valides : true : Enabled. false : Disabled.	false
BastionHostIngressIP	boolean	The asset type: BastionHostIngressIP. Valeurs valides : true : Enabled. false : Disabled.	false
EniEIP	boolean	The asset type: EniEIP. Valeurs valides : true : Enabled. false : Disabled.	false
NlbEIP	boolean	The asset type: NlbEIP. Valeurs valides : true : Enabled. false : Disabled.	false
ApiGatewayEIP	boolean	The asset type: ApigEIP. Valeurs valides : true : Enabled. false : Disabled.	false
EcsPublicIP	boolean	The asset type: EcsPublicIP. Valeurs valides : true : Enabled. false : Disabled.	false
BastionHostIP	boolean	The asset type: BastionHostIP. Valeurs valides : true : Enabled. false : Disabled.	false
BastionHostEgressIP	boolean	The asset type: BastionHostEgressIP. Valeurs valides : true : Enabled. false : Disabled.	false
AlbEIP	boolean	The asset type: AlbEIP. Valeurs valides : true : Enabled. false : Disabled.	false
GaEIP	boolean	The asset type: GaEIP. Valeurs valides : true : Enabled. false : Disabled.	false
AiGatewayEIP	boolean	The asset type: AIGatewayEIP. Valeurs valides : true : Enabled. false : Disabled.	false
EIP	boolean	The asset type: EIP. Valeurs valides : true : Enabled. false : Disabled.	false
NatEIP	boolean	The asset type: NatEIP. Valeurs valides : true : Enabled. false : Disabled.	false
SlbPublicIP	boolean	The asset type: SlbPublicIP. Valeurs valides : true : Enabled. false : Disabled.	false
EcsEIP	boolean	The asset type: EcsEIP. Valeurs valides : true : Enabled. false : Disabled.	false
HAVIP	boolean	The asset type: HAVIP. Valeurs valides : true : Enabled. false : Disabled.	false
Ipv6	object	The IPv6 asset type.
SlbIPv6	boolean	The asset type: SlbIPv6. Valeurs valides : true : Enabled. false : Disabled.	false
NlbIPv6	boolean	The asset type: NlbIPv6. Valeurs valides : true : Enabled. false : Disabled.	false
EniEIPv6	boolean	The asset type: EniEIPv6. Valeurs valides : true : Enabled. false : Disabled.	false
AlbIPv6	boolean	The asset type: AlbIPv6. Valeurs valides : true : Enabled. false : Disabled.	false
GaEIPv6	boolean	The asset type: GaEIPv6. Valeurs valides : true : Enabled. false : Disabled.	false
AiGatewayEIPv6	boolean	The asset type: AIGatewayEIPv6. Valeurs valides : true : Enabled. false : Disabled.	false
EcsIPv6	boolean	The asset type: EcsIPv6. Valeurs valides : true : Enabled. false : Disabled.	false
ApiGatewayEIPv6	boolean	The asset type: ApigEIPv6. Valeurs valides : true : Enabled. false : Disabled.	false

Exemples

JSON format

{
  "PageNo": "1",
  "PageSize": "10",
  "RequestId": "B36F150A-1E27-43AA-B72C-D2AC712F09DA",
  "TotalCount": "100",
  "Acls": [
    {
      "AddressListCount": 2,
      "GroupUuid": "f04ac7ce-628b-4cb7-be61-310222b7****",
      "AutoAddTagEcs": 1,
      "Description": "DEMO",
      "GroupName": "demo_address_book",
      "ReferenceCount": 3,
      "GroupType": "ip",
      "TagRelation": "and",
      "TagList": [
        {
          "TagValue": "ALL VALUE",
          "TagKey": "company"
        }
      ],
      "AddressList": [
        "[ \"192.168.XX.XX/32\", \"192.168.XX.XX/32\" ]"
      ],
      "Addresses": [
        {
          "Address": "192.168.0.1/32",
          "Note": "Single Address Description"
        }
      ],
      "AckClusterConnectorId": "ac-7c1bad6c3cc84c33baab",
      "AckClusterConnectorName": "ack-cluster-connector-name",
      "AckLabels": [
        {
          "Key": "app",
          "Value": "storage-operator"
        }
      ],
      "AckNamespaces": [
        "default"
      ],
      "RegionNo": "cn-beijing",
      "AssetMemberUids": [
        0
      ],
      "AssetRegionResourceTypes": [
        {
          "AssetRegionId": "all",
          "ResourceType": {
            "Ipv4": {
              "SlbEIP": true,
              "NatPublicIP": false,
              "BastionHostIngressIP": false,
              "EniEIP": false,
              "NlbEIP": false,
              "ApiGatewayEIP": false,
              "EcsPublicIP": false,
              "BastionHostIP": false,
              "BastionHostEgressIP": false,
              "AlbEIP": false,
              "GaEIP": false,
              "AiGatewayEIP": false,
              "EIP": false,
              "NatEIP": false,
              "SlbPublicIP": false,
              "EcsEIP": false,
              "HAVIP": false
            },
            "Ipv6": {
              "SlbIPv6": false,
              "NlbIPv6": false,
              "EniEIPv6": false,
              "AlbIPv6": false,
              "GaEIPv6": false,
              "AiGatewayEIPv6": false,
              "EcsIPv6": false,
              "ApiGatewayEIPv6": false
            }
          }
        }
      ]
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ErrorParametersGroupType	The group type is invalid.	The group type is invalid.
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.	Either pageSize or pageNo is invalid.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.

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

Notes de version

Consultez Notes de version pour la liste complète.