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

Consulta una instancia de algoritmo por el nombre de la instancia.

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/{instanceName} HTTP/1.1

Parámetros de ruta

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

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
output	string	No	Especifica el nivel de detalle de la información devuelta. Valores válidos: simple: muestra solo la información básica. normal: muestra información como createParameters y cron. Este es el valor predeterminado. detail: devuelve los detalles de la tarea de entrenamiento.	detail

Ejemplos de solicitudes

GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test?output=detail

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El cuerpo de la respuesta.	{}
status	string
httpCode	integer
requestId	string
message	string
code	string
result	object
belongs	object
category	string
domain	string
language	string
createParameters	array<object>
	object
name	string
value	string
usageParameters	array<object>
	object
name	string
value	string
createTime	integer
cron	string
description	string
extendInfo	string
functionName	string
functionType	string
instanceName	string
modelType	string
source	string
status	string
task	object
dagStatus	string
lastRunTime	integer
versionId	integer
modifyTime	integer
latency	integer

Ejemplos de respuestas correctas

{
    "status": "OK",
    "requestId": "",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "result": {
        "versionId": 100,
        "instanceName": "ctr_test",
        "functionName": "ctr",
        "functionType": "PAAS",
        "modelType": "tf_checkpoint",
        "description": "test",
        "status": "available",
        "belongs": {
            "domain": "ecommerce",
            "category": "general",
            "language": "zh"
        },
        "createTime": 100010,
        "createParameters": [
            {
                "name": "param1",
                "value": "val1"
            }
        ],
        "usageParameters": [
            {
                "name": "use_param1",
                "value": "val1"
            }
        ],
        "extendInfo": "{\"error\":{},\"dataReport\":{}}",
        "cron": "",
        "task": {
            "dagStatus": "running",
            "progress": 30,
            "lastRunTime": 200020
        }
    }
}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "status": "",
  "httpCode": 0,
  "requestId": "",
  "message": "",
  "code": "",
  "result": {
    "belongs": {
      "category": "",
      "domain": "",
      "language": ""
    },
    "createParameters": [
      {
        "name": "",
        "value": ""
      }
    ],
    "usageParameters": [
      {
        "name": "",
        "value": ""
      }
    ],
    "createTime": 0,
    "cron": "",
    "description": "",
    "extendInfo": "",
    "functionName": "",
    "functionType": "",
    "instanceName": "",
    "modelType": "",
    "source": "",
    "status": "",
    "task": {
      "dagStatus": "",
      "lastRunTime": 0
    },
    "versionId": 0,
    "modifyTime": 0
  },
  "latency": 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.