CreateInstance - OpenSearch - Centro de documentación de Alibaba Cloud

Crea una instancia de Wentian Engine.

Descripción de la operación

Método

POST

URI

/openapi/ha3/instances

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

searchengine:CreateInstance

create

*Instance.

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

Ninguna

Sintaxis de la solicitud

POST /openapi/ha3/instances HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
body	object	No	La estructura de la solicitud.	{}
chargeType	string	No	El método de facturación de la instancia. Valores válidos: PREPAY: suscripción. Si selecciona este método de facturación, asegúrese de que su cuenta admita el pago con saldo o el pago con crédito. De lo contrario, se devolverá un error InvalidPayMethod. También debe especificar el parámetro paymentInfo. POSTPAY: pago por uso (actualmente no admitido).	PREPAY
components	array<object>	No	La lista de especificaciones de la instancia.
	object	No	La lista de especificaciones de la instancia.
code	string	No	El código de especificación, que debe coincidir con el parámetro de ventas.	searcherdocsize
value	string	No	El valor introducido en el control.	200
order	object	No	La información de pago.
autoRenew	boolean	No	Especifica si se debe habilitar la renovación automática. Valores válidos: true y false.	true
duration	integer	No	La duración de la suscripción. Valores válidos: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 y 12.	29
pricingCycle	string	No	La unidad de la duración de la suscripción. Los valores válidos incluyen Month y Year.	Month
tags	array<object>	No	La lista de etiquetas de la instancia.
	object	No
key	string	No	La clave de la etiqueta.	opensearch
value	string	No	El valor de la etiqueta.	opensearch
resourceGroupId	string	No	El ID del grupo de recursos.	rg-aekzgpiswzbksdi

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
requestId	string	El ID de la solicitud.	D39EE0F1-D7EF-5F46-B781-6BF4185308B0
result	object	El resultado devuelto.
instanceId	string	El ID de la instancia.	ha-cn-pl32rf0****

Ejemplos de respuestas

Ejemplos de respuestas correctas

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

Ejemplos de respuestas de error

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

Para obtener más información, consulte Estructura de la respuesta.

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.