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

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

*FunctionTask

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

Ninguna

Sintaxis de la solicitud

GET /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks/{generation} 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
functionName	string	Sí	El nombre de la función.	ctr
instanceName	string	Sí	El nombre de la instancia.	test_model_2
generation	string	Sí	El número de iteraciones.	1

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

Ejemplo

GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/tasks/3

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
status	string	El estado de la solicitud. OK indica éxito y FAIL indica fallo.	OK
httpCode	integer	El código de estado HTTP.	200
requestId	string	El ID de la solicitud.	D77D0DAF-790D-F5F5-A9C0-133738165014
message	string	El mensaje de error.
code	string	El código de error.
result	object	Los detalles de la tarea de entrenamiento.
endTime	integer	La hora de finalización de la tarea de entrenamiento.	200020
extendInfo	string	La información extendida de la tarea de entrenamiento, en formato de cadena JSON.	{"recall":91,"errors":[]}
functionName	string	El nombre de la función a la que pertenece la tarea de entrenamiento.	ctr
generation	string	El número de iteraciones de entrenamiento.	3
progress	integer	El progreso de la tarea de entrenamiento.	100
runId	string	El ID de ejecución de la tarea de entrenamiento.	trigger__2021-03-05T12:18:41
startTime	integer	La hora de inicio de la tarea de entrenamiento.	100010
status	string	El estado de la tarea de entrenamiento.	success
latency	integer	La latencia de la solicitud, en milisegundos.	123

Ejemplos de respuestas correctas

{
    "status": "OK",
    "requestId": "",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "result": {
      "functionName": "ctr",
      "progress": 100,
      "status": "success",
      "startTime": 100010,
      "endTime": 200020,
      "extendInfo": "{\"recall\":91,\"errors\":[]}",
      "runId": "trigger__2021-03-05T12:18:41",
      "generation": "3"
    }
}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "status": "OK",
  "httpCode": 200,
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "message": "",
  "code": "",
  "result": {
    "endTime": 200020,
    "extendInfo": "{\"recall\":91,\"errors\":[]}",
    "functionName": "ctr",
    "generation": "3",
    "progress": 100,
    "runId": "trigger__2021-03-05T12:18:41",
    "startTime": 100010,
    "status": "success"
  },
  "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.