CreateInstance - - Centre de documentation Alibaba Cloud

Crée une instance Wentian Engine.

Description de l'opération

Méthode

POST

URI

/openapi/ha3/instances

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

create

*Instance.

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

Aucune

Syntaxe de la requête

POST /openapi/ha3/instances HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
body	object	Non	La structure de la requête.	{}
chargeType	string	Non	La méthode de facturation de l'instance. Valeurs valides : PREPAY : abonnement. Si vous sélectionnez cette méthode de facturation, assurez-vous que votre compte prend en charge le paiement par solde ou par crédit. Sinon, une erreur InvalidPayMethod est renvoyée. Vous devez également spécifier le paramètre paymentInfo. POSTPAY : paiement à l'usage (actuellement non pris en charge).	PREPAY
components	array<object>	Non	La liste des spécifications de l'instance.
	object	Non	La liste des spécifications de l'instance.
code	string	Non	Le code de spécification, qui doit être cohérent avec le paramètre de vente.	searcherdocsize
value	string	Non	La valeur saisie dans le contrôle.	200
order	object	Non	Les informations de paiement.
autoRenew	boolean	Non	Indique si le renouvellement automatique doit être activé. Valeurs valides : true et false.	true
duration	integer	Non	La durée de l'abonnement. Valeurs valides : 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 et 12.	29
pricingCycle	string	Non	L'unité de la durée de l'abonnement. Les valeurs valides incluent Month et Year.	Month
tags	array<object>	Non	La liste des balises de l'instance.
	object	Non
key	string	Non	La clé de la balise.	opensearch
value	string	Non	La valeur de la balise.	opensearch
resourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-aekzgpiswzbksdi

É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.	D39EE0F1-D7EF-5F46-B781-6BF4185308B0
result	object	Le résultat renvoyé.
instanceId	string	L'identifiant de l'instance.	ha-cn-pl32rf0****

Exemples de réponses

Exemples de réponses réussies

{
	"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",
  "result": {
      "instanceId": "deeprec-cn-xxxxxx1"
    }
}

Exemples de réponses d'erreur

{
	"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",
  "code": "InternalServerError",
  "message":"internal server error"
}

Pour plus d'informations, consultez Structure de la réponse.

Exemples

JSON format

{
  "requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0",
  "result": {
    "instanceId": "ha-cn-pl32rf0****"
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.