ListAppGroups - - Centre de documentation Alibaba Cloud

Obtient la liste des applications OpenSearch.

Description de l'opération

Prend en charge le filtrage par nom, instanceId et type.
Prend en charge le tri par heure de création de l'application.
Prend en charge les paramètres de pagination.

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.

opensearch:ListAppGroup

list

*AppGroup.

acs:opensearch:{#regionId}:{#accountId}:app-groups/*

Aucune

Syntaxe de la requête

GET /v4/openapi/app-groups HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
pageNumber	integer	Non	Le numéro de page. Valeur par défaut : 1.	1
pageSize	integer	Non	Le nombre d'entrées par page. Valeur par défaut : 10.	10
instanceId	string	Non	L'identifiant de l'instance (correspondance exacte).	ops-cn-xxxx
name	string	Non	Le nom de l'application.	my_name
type	string	Non	Le type d'application. Valeurs valides : standard : Édition standard. enhanced : nouvelle édition avancée.	standard
sortBy	integer	Non	L'ordre de tri. Valeurs valides : 0 : trie par heure de création dans l'ordre décroissant. 1 : trie par heure de modification dans l'ordre décroissant. Valeur par défaut : 0.	0
resourceGroupId	string	Non	L'identifiant de la ressource.	"110123123"
tags	array<object>	Non	La liste des balises.
	object	Non
key	string	Non	La clé de la balise.	foo
value	string	Non	La valeur de la balise.	bar

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le corps de la réponse.	{}
totalCount	integer	Le nombre total d'entrées.	1
requestId	string	L'identifiant de la requête.	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	object	Les informations de l'application. Pour plus d'informations, consultez AppGroup.	{}
beaconAppCreated	integer
chargeType	string	Le type de facturation. Valeurs valides : POSTPAY : paiement à l'usage. PREPAY : abonnement.	POSTPAY
chargingWay	integer	La méthode de facturation. Valeurs valides : 1 : ressource de calcul. 2 : QPS.	1
commodityCode	string	Le code produit.	opensearch
components	array<object>
	object
code	string
value	string
created	integer	L'horodatage de création.	1575442875
currentVersion	string	La version en ligne actuelle.	110116134
description	string	La description de l'application.	"xxx"
domain	string	Le domaine.	""
domainName	string
engineType	string	Le type de moteur.	ha3
hasPendingQuotaReviewTask	integer	Indique si une révision de quota est en cours. Valeurs valides : 0 : Normal. 1 : Révision de quota en cours.	0
id	string	L'identifiant de l'application.	110116134
inDebt	boolean
instanceId	string	L'identifiant de l'instance.	"xxx"
lockMode	string	L'état de verrouillage. Valeurs valides : Unlock : Normal. LockByExpiration : verrouillé automatiquement en raison de l'expiration de l'instance. ManualLock : verrouillé manuellement.	Unlock
name	string	Le nom de l'application.	os_function_test_v1
produced	integer	Indique si la production est terminée. Valeurs valides : 0 : En production. 1 : Production terminée.	1
quota	object	Les informations de quota de l'application. Pour plus d'informations, consultez Quota.	{}
computeResource	integer	La ressource de calcul. Unité : LCU.	20
docSize	integer	La capacité de stockage. Unité : Go.	1
spec	string	La spécification. Valeurs valides : opensearch.share.junior : niveau d'entrée. opensearch.share.common : usage général partagé. opensearch.share.compute : optimisé pour le calcul partagé. opensearch.share.storage : optimisé pour le stockage partagé. opensearch.private.common : usage général dédié. opensearch.private.compute : optimisé pour le calcul dédié. opensearch.private.storage : optimisé pour le stockage dédié.	opensearch.share.common
resourceGroupId	string
status	string	L'état de l'application. Valeurs valides : producing : en production. review_pending : en attente de révision de production. config_pending : en attente de configuration. normal : Normal. frozen : gelé.	normal
switchedTime	integer	L'horodatage du basculement de la version en ligne.	0
tags	array<object>	Les balises de l'application.
	object	La balise.
key	string	La clé de la balise.	foo
value	string	La valeur de la balise.	bar
type	string	Le type d'application. Valeurs valides : standard : Édition standard. enhanced : nouvelle édition avancée.	enhanced
updated	integer	L'horodatage de mise à jour.	1578916076
versions	array
	string
zoneId	string
elasticLcu	integer

Exemples

JSON format

{
  "totalCount": 1,
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "beaconAppCreated": 0,
    "chargeType": "POSTPAY",
    "chargingWay": 1,
    "commodityCode": "opensearch",
    "components": [
      {
        "code": "",
        "value": ""
      }
    ],
    "created": 1575442875,
    "currentVersion": "110116134",
    "description": "\"xxx\"",
    "domain": "\"\"",
    "domainName": "",
    "engineType": "ha3",
    "hasPendingQuotaReviewTask": 0,
    "id": "110116134",
    "inDebt": false,
    "instanceId": "\"xxx\"",
    "lockMode": "Unlock",
    "name": "os_function_test_v1",
    "produced": 1,
    "quota": {
      "computeResource": 20,
      "docSize": 1,
      "spec": "opensearch.share.common"
    },
    "resourceGroupId": "",
    "status": "normal",
    "switchedTime": 0,
    "tags": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "type": "enhanced",
    "updated": 1578916076,
    "versions": [
      ""
    ],
    "zoneId": "",
    "elasticLcu": 0
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.