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

Obtiene la lista de aplicaciones de OpenSearch.

Descripción de la operación

Admite el filtrado por nombre, instanceId y tipo.
Admite la ordenación por hora de creación de la aplicación.
Admite parámetros de paginación.

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

list

*AppGroup

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

Ninguna

Sintaxis de la solicitud

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

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
pageNumber	integer	No	El número de página. Valor predeterminado: 1.	1
pageSize	integer	No	El número de entradas por página. Valor predeterminado: 10.	10
instanceId	string	No	El ID de la instancia (coincidencia exacta).	ops-cn-xxxx
name	string	No	El nombre de la aplicación.	my_name
type	string	No	El tipo de aplicación. Valores válidos: standard: Edición estándar. enhanced: nueva edición avanzada.	standard
sortBy	integer	No	El orden de clasificación. Valores válidos: 0: ordena por hora de creación en orden descendente. 1: ordena por hora de modificación en orden descendente. Valor predeterminado: 0.	0
resourceGroupId	string	No	El ID del recurso.	"110123123"
tags	array<object>	No	La lista de etiquetas.
	object	No
key	string	No	La clave de la etiqueta.	foo
value	string	No	El valor de la etiqueta.	bar

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El cuerpo de la respuesta.	{}
totalCount	integer	El número total de entradas.	1
requestId	string	El ID de la solicitud.	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	object	La información de la aplicación. Para obtener más información, consulte AppGroup.	{}
beaconAppCreated	integer
chargeType	string	El tipo de facturación. Valores válidos: POSTPAY: pago por uso. PREPAY: suscripción.	POSTPAY
chargingWay	integer	El método de facturación. Valores válidos: 1: recurso de computación. 2: QPS.	1
commodityCode	string	El código del producto.	opensearch
components	array<object>
	object
code	string
value	string
created	integer	La marca de tiempo de creación.	1575442875
currentVersion	string	La versión en línea actual.	110116134
description	string	La descripción de la aplicación.	"xxx"
domain	string	El dominio.	""
domainName	string
engineType	string	El tipo de motor.	ha3
hasPendingQuotaReviewTask	integer	Indica si hay una revisión de cuota en curso. Valores válidos: 0: Normal. 1: Revisión de cuota en curso.	0
id	string	El ID de la aplicación.	110116134
inDebt	boolean
instanceId	string	El ID de la instancia.	"xxx"
lockMode	string	El estado de bloqueo. Valores válidos: Unlock: Normal. LockByExpiration: bloqueado automáticamente por vencimiento de la instancia. ManualLock: bloqueado manualmente.	Unlock
name	string	El nombre de la aplicación.	os_function_test_v1
produced	integer	Indica si la producción está completa. Valores válidos: 0: En producción. 1: Producción completa.	1
quota	object	La información de cuota de la aplicación. Para obtener más información, consulte Quota.	{}
computeResource	integer	El recurso de computación. Unidad: LCU.	20
docSize	integer	La capacidad de almacenamiento. Unidad: GB.	1
spec	string	La especificación. Valores válidos: opensearch.share.junior: nivel de entrada. opensearch.share.common: propósito general compartido. opensearch.share.compute: optimizado para cómputo compartido. opensearch.share.storage: optimizado para almacenamiento compartido. opensearch.private.common: propósito general dedicado. opensearch.private.compute: optimizado para cómputo dedicado. opensearch.private.storage: optimizado para almacenamiento dedicado.	opensearch.share.common
resourceGroupId	string
status	string	El estado de la aplicación. Valores válidos: producing: en producción. review_pending: revisión de producción pendiente. config_pending: configuración pendiente. normal: Normal. frozen: congelado.	normal
switchedTime	integer	La marca de tiempo en la que se cambió la versión en línea.	0
tags	array<object>	Las etiquetas de la aplicación.
	object	La etiqueta.
key	string	La clave de la etiqueta.	foo
value	string	El valor de la etiqueta.	bar
type	string	El tipo de aplicación. Valores válidos: standard: Edición estándar. enhanced: nueva edición avanzada.	enhanced
updated	integer	La marca de tiempo de actualización.	1578916076
versions	array
	string
zoneId	string
elasticLcu	integer

Ejemplos

Respuesta exitosa

JSON Formato

{
  "totalCount": 1,
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "beaconAppCreated": 0,
    "chargeType": "POSTPAY",
    "chargingWay": 1,
    "commodityCode": "opensearch",
    "components": [
      {
        "code": "",
        "value": ""
      }
    ],
    "created": 1575442875,
    "currentVersion": "110116134",
    "description": "\"xxx\"",
    "domain": "\"\"",
    "domainName": "",
    "engineType": "ha3",
    "hasPendingQuotaReviewTask": 0,
    "id": "110116134",
    "inDebt": false,
    "instanceId": "\"xxx\"",
    "lockMode": "Unlock",
    "name": "os_function_test_v1",
    "produced": 1,
    "quota": {
      "computeResource": 20,
      "docSize": 1,
      "spec": "opensearch.share.common"
    },
    "resourceGroupId": "",
    "status": "normal",
    "switchedTime": 0,
    "tags": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "type": "enhanced",
    "updated": 1578916076,
    "versions": [
      ""
    ],
    "zoneId": "",
    "elasticLcu": 0
  }
}

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.