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

Consulta todas las instancias que cumplen las condiciones especificadas.

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

get

*FunctionInstance

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

Ninguna

Sintaxis de la solicitud

GET /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
appGroupIdentity	string	Sí	El nombre de la aplicación.	app_group_name
functionName	string	Sí	El nombre de la función.	ctr

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
modelType	string	No	El tipo de modelo.	tf_checkpoint
functionType	string	No	El tipo de función.	"PAAS"
source	string	No	El origen de la instancia. Valores válidos: builtin: instancia del sistema user: instancia de usuario (valor predeterminado) all: todas las instancias	user
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
output	string	No	El nivel de detalle de la información devuelta. Valores válidos: normal: muestra información como createParameters y cron (valor predeterminado) simple: muestra solo información básica detail: devuelve información detallada sobre la tarea de entrenamiento	normal

Ejemplo

GET /v4/openapi/app-groups/my-app/functions/ctr/instances?source=all&output=simple

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El cuerpo de la respuesta.
status	string	El estado de la solicitud.	OK
httpCode	integer	El código de estado HTTP.	200
totalCount	integer	El número total de entradas.	2
requestId	string	El ID de la solicitud.	A4D487A9-A456-5AA5-A9C6-B7BF2889CF74
message	string	El mensaje de error. Este parámetro está vacío si la solicitud se realiza correctamente.	instance not exist.
code	string	El código de error. Este parámetro está vacío si la solicitud se realiza correctamente.	Instance.NotExist
result	array<object>	La lista de resultados.
	array<object>	La información de la instancia.
belongs	object	La información de propiedad de la instancia.
category	string	La categoría vertical.	general
domain	string	La industria.	ecommerce
language	string	La abreviatura del idioma aplicable.	zh
createParameters	array<object>	La lista de parámetros de la instancia.
	object	El objeto de parámetro.
name	string	El nombre.	param1
value	string	El valor.	value1
usageParameters	array<object>	La lista de parámetros de uso.
	object	El objeto de parámetro.
	string
createTime	integer	La hora de creación.	1234
description	string	La descripción.
functionName	string	El nombre de la función.	ctr
functionType	string	El tipo de función.	PAAS
instanceName	string	El nombre de la instancia.	ctr_test
modelType	string	El tipo de modelo.	tf_checkpoint
source	string	El origen de la instancia. Valores válidos: user: instancia de usuario builtin: instancia integrada	user
status	string	El estado de la instancia. Valores válidos: unavailable: ningún modelo disponible (se requiere entrenamiento) available: disponible	available
versionId	integer	El ID de la versión.	123
extendInfo	string	La información de extensión. El valor es una cadena JSON que contiene información de evaluación del modelo, información de fallas y más.	{"dataReport":{},"errors":{}}
cron	string	La información de entrenamiento en sintaxis cron (Minutos Horas Día del mes Mes Día de la semana). Un valor vacío indica que no se realiza entrenamiento periódico.	0 3 ? * 0,1,3,5
task	object	La información de la tarea de entrenamiento. Este campo no se muestra cuando no existe ninguna tarea.
dagStatus	string	El estado de la tarea. Valores válidos: success: La tarea se completó correctamente. failed: La tarea falló. untrained: La tarea está pendiente de entrenamiento. pending: La tarea se está programando. running: La tarea está en proceso de entrenamiento.	success
lastRunTime	integer	La hora de la última ejecución. Unidad: milisegundos.	1234
modifyTime	integer
latency	integer	La latencia de la solicitud de API. Unidad: milisegundos.	123

Ejemplo de respuesta exitosa:

{
    "status": "OK",
    "requestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "totalCount": 2,
    "result": [
        {
            "versionId": 100,
            "instanceName": "instance_1",
            "functionName": "hot",
            "functionType": "PAAS",
            "modelType": "offline_inference",
            "description": "",
            "status": "available",
            "belongs": {
                "domain": "ecommerce",
                "category": "general",
                "language": "zh"
            },
            "createTime": 100010,
            "source": "user"
        },
        {
            "versionId": 100,
            "instanceName": "instance_2",
            "functionName": "hot",
            "functionType": "PAAS",
            "modelType": "offline_inference",
            "description": "",
            "status": "available",
            "belongs": {
                "domain": "ecommerce",
                "category": "general",
                "language": "zh"
            },
            "createTime": 200020,
            "source": "user",
            "default": true
        }
    ]
}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "status": "OK",
  "httpCode": 200,
  "totalCount": 2,
  "requestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",
  "message": "instance not exist.",
  "code": "Instance.NotExist",
  "result": [
    {
      "belongs": {
        "category": "general",
        "domain": "ecommerce",
        "language": "zh"
      },
      "createParameters": [
        {
          "name": "param1",
          "value": "value1"
        }
      ],
      "usageParameters": [
        {
          "key": ""
        }
      ],
      "createTime": 1234,
      "description": "",
      "functionName": "ctr",
      "functionType": "PAAS",
      "instanceName": "ctr_test",
      "modelType": "tf_checkpoint",
      "source": "user",
      "status": "available",
      "versionId": 123,
      "extendInfo": "{\"dataReport\":{},\"errors\":{}}",
      "cron": "0 3 ? * 0,1,3,5",
      "task": {
        "dagStatus": "success",
        "lastRunTime": 1234
      },
      "modifyTime": 0
    }
  ],
  "latency": 123
}

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.