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

Crea una instancia de algoritmo para una función especificada.

Descripción de la operación

Por lo general, se llama a la operación GetFunctionCurrentVersion para obtener la versión más reciente que utiliza la función actual. La versión describe las listas de parámetros createParameters y usageParameters necesarios para crear una instancia, así como los requisitos de los parámetros.

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

create

*FunctionInstance

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

Ninguna

Sintaxis de la solicitud

POST /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.	my_app_group_name
functionName	string	Sí	El nombre de la función. Modelos admitidos: Modelo CTR: ctr Modelo de popularidad: pop Modelo de categoría: category Modelo de palabras populares: hot Modelo de sugerencias: hint Modelo de sugerencias desplegables: suggest Modelo de tokenización: analyzer Modelo de ponderación de términos: termweight Modelo de sinónimos: synonym	ctr

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
body	object	No	Los parámetros del cuerpo.
instanceName	string	Sí	El nombre de la instancia.	my_ctr
modelType	string	Sí	El tipo de modelo.	tf_checkpoint
functionType	string	No	El tipo de función.	PAAS
description	string	No	La descripción de la instancia.
createParameters	array<object>	No	Los parámetros de creación.
	object	No	El elemento de parámetro.
name	string	No	El nombre del parámetro.	id_field
value	string	No	El valor del parámetro.	id
usageParameters	array<object>	No	Los parámetros de uso.
	object	No
name	string	No	El nombre del parámetro.	allow_dict_id
value	string	No	El valor del parámetro.	123
cron	string	No	El entrenamiento periódico.	0 0 ? * 0,1,3,5

Ejemplo (ctr)

POST /v4/openapi/app-groups/my-app/functions/ctr/instances
{
    "instanceName": "my_ctr",
    "modelType": "tf_checkpoint",
    "functionType": "PAAS",
    "cron": "0 0 ? * 0,1,3,5",
    "description": "",
    "createParameters": [
        {
            "name": "id_field",
            "value": "id"
        },
        {
            "name": "title_field",
            "value": "title"
        }
    ],
    "usageParameters": []
}

Ejemplo (hot)

POST /v4/openapi/app-groups/my-app/functions/hot/instances
{
    "instanceName":"my_hot",
    "modelType":"offline_inference",
    "functionType":"PAAS",
    "createParameters":[
        {
            "name":"filter",
            "value":"biz_type != 1"
        }
    ],
    "usageParameters": [
        {
            "name":"allow_dict_id",
            "value":"123"
        },
        {
            "name":"deny_dict_id",
            "value":"456"
        }
    ],
    "cron":"12 4 ? * 1,2,3,4,5,6,0"
}

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros del cuerpo.	{ "status" : "OK", "requestId" : "", "httpCode": 200, "code": "", "message": "", "latency" : 123, "result" : { } }
status	string		OK
httpCode	integer		200
requestId	string		98724351-D6B2-5D8A-B089-7FFD1821A7E9
message	string
code	string
latency	integer		123

Ejemplo de respuesta exitosa:

{
  "status" : "OK",
  "requestId" : "98724351-D6B2-5D8A-B089-7FFD1821A7E9",
  "httpCode": 200,
  "code": "",
  "message": "",
  "latency" : 123,
  "result" : {}
}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "status": "OK",
  "httpCode": 200,
  "requestId": "98724351-D6B2-5D8A-B089-7FFD1821A7E9",
  "message": "",
  "code": "",
  "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.