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

Modifica las propiedades de una aplicación de OpenSearch o establece su versión en línea.

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

update

*AppGroup

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

Ninguna

Sintaxis de la solicitud

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

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
appGroupIdentity	string	Sí	El nombre de la aplicación.	my_app_group_name

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
body	object	No	El cuerpo de la solicitud.
description	string	No	La descripción del grupo de aplicaciones.	"Instance description"
currentVersion	string	No	La versión en línea de la aplicación.	1223232
domain	string	No	La industria. Valores válidos: general: general. ecommerce: comercio electrónico. education: educación. esports: videojuegos. community: comunidad de contenido.	"ecommerce"
resourceGroupId	string	No	El ID del grupo de recursos al que pertenece la instancia.	rg-****
dryRun	boolean	No	Especifica si se debe realizar la validación previa a la actualización. Valores válidos: true (validar) y false (no validar).	true

Cuerpo de la solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
chargingWay	Integer	No	1	El modelo de facturación. - 1: recursos de computación. - 2: consultas por segundo (QPS).
description	String	No	"my_first_app"	La descripción de la aplicación.
currentVersion	Integer	No	12345678	El ID de la versión de la aplicación.

Nota: Esta operación prioriza el establecimiento de la versión en línea de la aplicación. Si se proporcionan todos los campos, currentVersion tiene prioridad.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El cuerpo de la respuesta.	{}
requestId	string	El ID de la solicitud.	D77D0DAF-790D-F5F5-A9C0-133738165014
result	object	Los datos devueltos.	{}
beaconAppCreated	integer
chargeType	string	El método de facturación. Valores válidos: POSTPAY: pago por uso. PREPAY: suscripción.	POSTPAY
chargingWay	integer	El elemento facturable. Valores válidos: 1: recursos de computación. 2: QPS.	1
commodityCode	string	El código de producto.	opensearch
created	integer	La marca de tiempo UNIX en la que se creó la aplicación.	159013954
currentVersion	string	El ID de la versión en línea actual.	100302903
description	string	La descripción de la aplicación.	1
domain	string	La industria. Valores válidos: GENERAL: general. ECOMMERCE: comercio electrónico. IT_CONTENT: contenido de TI.	GENERAL
domainName	string
engineType	string	El tipo de motor.	ha3
hasPendingQuotaReviewTask	integer	El estado de aprobación de la cuota. Valores válidos: 0: normal. 1: en proceso de aprobación.	0
id	string	El ID de la aplicación.	100302881
inDebt	boolean
instanceId	string	El ID de la instancia.	10030288
lockMode	string	El modo de bloqueo de la instancia. Valores válidos: Unlock: La instancia no está bloqueada. LockByExpiration: La instancia se bloquea automáticamente después de que caduca. ManualLock: La instancia está bloqueada manualmente.	Unlock
name	string	El nombre de la aplicación.	lsh_test_1
produced	integer	Indica si la aplicación está creada. Valores válidos: 0: La aplicación se está creando. 1: La aplicación está creada.	1
quota	object	La información de cuota de la aplicación.	{}
computeResource	integer	Los recursos de computación en unidades de computación lógica (LCU).	20
docSize	integer	La capacidad de almacenamiento en GB.	1
spec	string	Las especificaciones. Valores válidos: opensearch.share.junior: Básica opensearch.share.common: Compartida de propósito general opensearch.share.compute: Compartida optimizada para computación opensearch.share.storage: Compartida optimizada para almacenamiento opensearch.private.common: Exclusiva de propósito general opensearch.private.compute: Exclusiva optimizada para computación opensearch.private.storage: Exclusiva optimizada para almacenamiento	opensearch.share.common
resourceGroupId	string	El ID del grupo de recursos al que pertenece la instancia.	rg-acfmoiyerh6nzly
status	string	El estado de la aplicación. Valores válidos: producing: La aplicación se está creando. review_pending: La aplicación está en proceso de revisión. config_pending: La aplicación requiere configuración. normal: La aplicación está en ejecución. frozen: La aplicación está congelada.	normal
switchedTime	integer	La marca de tiempo UNIX en la que se cambió la versión en línea.	1590486386
type	string	El tipo de aplicación. Valores válidos: standard: una aplicación de la edición estándar. advance: una aplicación de la edición avanzada heredada. Las nuevas aplicaciones no admiten este tipo. enhanced: una aplicación de la nueva edición avanzada.	enhanced
updated	integer	La marca de tiempo UNIX en la que se modificó la aplicación por última vez.	1590978265
zoneId	string
components	array<object>
	object
code	string
value	string
tags	array<object>
	object
key	string
value	string
versions	array
	string

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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": [
      ""
    ]
  }
}

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.