UpdateInstance - - Centre de documentation Alibaba Cloud

Description de l'opération

Méthode

PUT

URI

/openapi/ha3/instances/{instanceId}

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.

searchengine:UpdateInstance

update

*Instance.

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

Aucune

Syntaxe de la requête

PUT /openapi/ha3/instances/{instanceId} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Non	L'identifiant de l'instance.	ha-cn-pl32rf0****

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
body	object	Non	Le corps de la requête.	{}
components	array<object>	Non	La liste des spécifications de l'instance. Vous ne pouvez pas mettre à jour ce paramètre en même temps que description.
	object	Non	La spécification de l'instance.
code	string	Non	Le code de spécification, qui doit être cohérent avec les paramètres de vente.	searcherdocsizesum
value	string	Non	La valeur.	200
orderType	string	Non	Valeurs valides : UPGRAGE : Met à niveau les spécifications de l'instance. DOWNGRADE : Rétrograde les spécifications de l'instance. Vous ne pouvez pas spécifier ce paramètre en même temps que description.	UPGRAGE
description	string	Non	La description de l'instance. Vous ne pouvez pas mettre à jour ce paramètre en même temps que components ou orderType.	Instance description

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
result	object	Le résultat renvoyé.
description	string	La description de l'instance.	Test instance
resourceGroupId	string	L'identifiant du groupe de ressources.	ha-cn-pl32rf0****
expiredTime	string	L'heure d'expiration au format YYYY-MM-DDTHH:mm:ss.S.	2019-01-06T16:00:00.0
commodityCode	string	Le code produit.	opensearch_ha3post_public_cn
status	string	L'état.	READY
instanceId	string	L'identifiant de la ressource principale.	ha-cn-pl32rf0****
createTime	string	L'heure de création au format YYYY-MM-DDTHH:mm:ss.S.	2018-12-06T11:17:49.0
lockMode	string	L'état du verrouillage.	Unlock
chargeType	string	Le mode de facturation.	POSTPAY
updateTime	string	L'heure de mise à jour au format YYYY-MM-DDTHH:mm:ss.S.	2018-12-06T11:17:49.0
inDebt	boolean	Indique si l'instance présente un retard de paiement.	false
requestId	string	L'identifiant de la requête.	90D6B8F5-FE97-4509-9AAB-367836C51818

Exemples

JSON format

{
  "result": {
    "description": "Test instance",
    "resourceGroupId": "ha-cn-pl32rf0****",
    "expiredTime": "2019-01-06T16:00:00.0",
    "commodityCode": "opensearch_ha3post_public_cn",
    "status": "READY",
    "instanceId": "ha-cn-pl32rf0****",
    "createTime": "2018-12-06T11:17:49.0",
    "lockMode": "Unlock",
    "chargeType": "POSTPAY",
    "updateTime": "2018-12-06T11:17:49.0",
    "inDebt": false
  },
  "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.