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

Crea una aplicación de OpenSearch.

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

opensearch:CreateAppGroup

create

*AppGroup

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

Ninguna

Sintaxis de la solicitud

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

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
body	object	No	El cuerpo de la solicitud.
name	string	No	El nombre de la aplicación.	jmbon_analyzer
chargeType	string	No	El método de facturación. Valores válidos: POSTPAY: pago por uso. PREPAY: suscripción.	POSTPAY
type	string	No	El tipo de aplicación. Valores válidos: standard: Edición estándar enhanced: Edición avanzada	enhanced
resourceGroupId	string	No	El ID del grupo de recursos al que pertenece la instancia.	rg-acfm2ij6pwxsvua
tags	array<object>	No	La lista de etiquetas.
	object	No	El par clave-valor de la etiqueta.
key	string	No	La clave de la etiqueta.	a
value	string	No	El valor de la etiqueta.	1
quota	object	No	La cuota.
docSize	integer	No	La capacidad de almacenamiento. Unidad: GB.	1
computeResource	integer	No	El recurso de cómputo. Unidad: LCU.	20
spec	string	No	Las especificaciones. Valores válidos: opensearch.share.junior: nivel de entrada opensearch.share.common: uso general compartido opensearch.share.compute: optimizado para cómputo compartido opensearch.share.storage: optimizado para almacenamiento compartido opensearch.private.common: uso general dedicado opensearch.private.compute: optimizado para cómputo dedicado opensearch.private.storage: optimizado para almacenamiento dedicado	opensearch.share.common
order	object	No
duration	integer	No
pricingCycle	string	No
autoRenew	boolean	No
dryRun	boolean	No

Cuerpo de la solicitud

Campo	Tipo	Obligatorio	Ejemplo	Descripción
name	String	Sí	"my_app"	El nombre de la aplicación.
type	String	Sí	"standard"	El tipo de aplicación. Valores válidos: - standard: Edición estándar - enhanced: Edición avanzada
quota	Object	Sí		La información de cuota de la aplicación. Para obtener más información, consulte Cuota.
chargeType	String	No	"POSTPAY"	El método de facturación. Valores válidos: - POSTPAY: pago por uso. Este es el valor predeterminado. - PREPAY: suscripción.
order	Object	No	{"duration": 1,"pricingCycle": "Year"}	La información del periodo de suscripción.
order.duration	Integer	--	1	El periodo de suscripción. El valor mínimo es 0.
order.pricingCycle	String	--	"Year"	La unidad del periodo de suscripción. Valores válidos: - Year - Month
order.autoRenew	Boolean	No	true	Especifica si se debe habilitar la renovación automática. Este parámetro solo surte efecto cuando el parámetro chargeType se establece en PREPAY. Valores válidos: - true: habilita la renovación automática. - false: deshabilita la renovación automática. Este es el valor predeterminado.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El cuerpo de la respuesta.
requestId	string	El ID de la solicitud.	766CF6DB-CA02-3E12-7CBA-6AC21FC978FD
result	object	Nulo.
instanceId	string	El ID de la instancia.	-

Ejemplos

Respuesta exitosa

JSON Formato

{
  "requestId": "766CF6DB-CA02-3E12-7CBA-6AC21FC978FD",
  "result": {
    "instanceId": "-"
  }
}

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.