ModifyAppGroup - - Centre de documentation Alibaba Cloud

Modifie les propriétés d'une application OpenSearch ou définit sa version en ligne.

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

update

*AppGroup

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

Aucune

Syntaxe de la requête

PUT /v4/openapi/app-groups/{appGroupIdentity} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
appGroupIdentity	string	Oui	Le nom de l'application.	my_app_group_name

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
body	object	Non	Le corps de la requête.
description	string	Non	La description du groupe d'applications.	"实例描述"
currentVersion	string	Non	La version en ligne de l'application.	1223232
domain	string	Non	Le secteur d'activité. Valeurs valides : general : général. ecommerce : e-commerce. education : éducation. esports : jeux vidéo. community : communauté de contenu.	"ecommerce"
resourceGroupId	string	Non	L'identifiant du groupe de ressources auquel l'instance appartient.	rg-****
dryRun	boolean	Non	Indique si une validation préalable à la mise à niveau doit être effectuée. Valeurs valides : true (valider) et false (ne pas valider).	true

Corps de la requête

Paramètre	Type	Obligatoire	Exemple	Description
chargingWay	Integer	Non	1	Le modèle de facturation. - 1 : ressources de calcul. - 2 : requêtes par seconde (QPS).
description	String	Non	"my_first_app"	La description de l'application.
currentVersion	Integer	Non	12345678	L'identifiant de la version de l'application.

Remarque : Cette opération priorise la définition de la version en ligne de l'application. Si tous les champs sont fournis, currentVersion est prioritaire.

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le corps de la réponse.	{}
requestId	string	L'identifiant de la requête.	D77D0DAF-790D-F5F5-A9C0-133738165014
result	object	Les données renvoyées.	{}
beaconAppCreated	integer
chargeType	string	La méthode de facturation. Valeurs valides : POSTPAY : paiement à l'usage. PREPAY : abonnement.	POSTPAY
chargingWay	integer	L'élément facturable. Valeurs valides : 1 : ressources de calcul. 2 : QPS.	1
commodityCode	string	Le code produit.	opensearch
created	integer	L'horodatage UNIX de la création de l'application.	159013954
currentVersion	string	L'identifiant de la version en ligne actuelle.	100302903
description	string	La description de l'application.	1
domain	string	Le secteur d'activité. Valeurs valides : GENERAL : général. ECOMMERCE : e-commerce. IT_CONTENT : contenu informatique.	GENERAL
domainName	string
engineType	string	Le type de moteur.	ha3
hasPendingQuotaReviewTask	integer	L'état d'approbation du quota. Valeurs valides : 0 : normal. 1 : en cours d'approbation.	0
id	string	L'identifiant de l'application.	100302881
inDebt	boolean
instanceId	string	L'identifiant de l'instance.	10030288
lockMode	string	Le mode de verrouillage de l'instance. Valeurs valides : Unlock : L'instance n'est pas verrouillée. LockByExpiration : L'instance est automatiquement verrouillée après son expiration. ManualLock : L'instance est verrouillée manuellement.	Unlock
name	string	Le nom de l'application.	lsh_test_1
produced	integer	Indique si l'application est créée. Valeurs valides : 0 : L'application est en cours de création. 1 : L'application est créée.	1
quota	object	Les informations de quota de l'application.	{}
computeResource	integer	Les ressources de calcul en unités de calcul logiques (LCU).	20
docSize	integer	La capacité de stockage en Go.	1
spec	string	Les spécifications. Valeurs valides : opensearch.share.junior : Basique 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 exclusif opensearch.private.compute : Optimisé pour le calcul exclusif opensearch.private.storage : Optimisé pour le stockage exclusif	opensearch.share.common
resourceGroupId	string	L'identifiant du groupe de ressources auquel l'instance appartient.	rg-acfmoiyerh6nzly
status	string	L'état de l'application. Valeurs valides : producing : L'application est en cours de création. review_pending : L'application est en cours d'examen. config_pending : L'application nécessite une configuration. normal : L'application est en cours d'exécution. frozen : L'application est gelée.	normal
switchedTime	integer	L'horodatage UNIX du changement de version en ligne.	1590486386
type	string	Le type de l'application. Valeurs valides : standard : une application Édition Standard. advance : une application Édition Avancée héritée. Les nouvelles applications ne prennent pas en charge ce type. enhanced : une application Nouvelle Édition Avancée.	enhanced
updated	integer	L'horodatage UNIX de la dernière modification de l'application.	1590978265
zoneId	string
components	array<object>
	object
code	string
value	string
tags	array<object>
	object
key	string
value	string
versions	array
	string

Exemples

JSON format

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": {
    "beaconAppCreated": 0,
    "chargeType": "POSTPAY",
    "chargingWay": 1,
    "commodityCode": "opensearch",
    "created": 159013954,
    "currentVersion": "100302903",
    "description": "1",
    "domain": "GENERAL",
    "domainName": "",
    "engineType": "ha3",
    "hasPendingQuotaReviewTask": 0,
    "id": "100302881",
    "inDebt": false,
    "instanceId": "10030288",
    "lockMode": "Unlock",
    "name": "lsh_test_1",
    "produced": 1,
    "quota": {
      "computeResource": 20,
      "docSize": 1,
      "spec": "opensearch.share.common"
    },
    "resourceGroupId": "rg-acfmoiyerh6nzly",
    "status": "normal",
    "switchedTime": 1590486386,
    "type": "enhanced",
    "updated": 1590978265,
    "zoneId": "",
    "components": [
      {
        "code": "",
        "value": ""
      }
    ],
    "tags": [
      {
        "key": "",
        "value": ""
      }
    ],
    "versions": [
      ""
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.