GetFunctionInstance - - Centre de documentation Alibaba Cloud

Obtient les détails d'une instance par nom d'instance.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

opensearch:DescribeFunction

get

*FunctionInstance.

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

Aucune

Syntaxe de la requête

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

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
appGroupIdentity	string	Oui	Le nom de l'application.	150057101
functionName	string	Oui	Le nom de la fonctionnalité.	ctr
instanceName	string	Oui	Le nom de l'instance.	ctr_test

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
output	string	Non	Contrôle la richesse des informations renvoyées. Valeurs valides : simple : renvoie uniquement les informations de base. normal : renvoie des informations telles que createParameters et cron. Il s'agit de la valeur par défaut. detail : renvoie les informations sur les tâches d'entraînement.	detail

Exemple

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

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le corps de la réponse.	{}
status	string	L'état de la requête.	OK
httpCode	integer	Le code d'état HTTP.	200
requestId	string	L'identifiant de la requête.	68ED4E1B-92B8-5821-A886-9C90686139EB
message	string	Le message d'erreur renvoyé.	instance not exist.
code	string	Le code d'erreur renvoyé. Ce paramètre est vide si aucune erreur ne se produit.	Instance.NotExist
result	object	Les détails de l'instance.
belongs	object	Les informations d'appartenance.
category	string	La catégorie verticale.	general
domain	string	Le secteur d'activité.	ecommerce
language	string	L'abréviation de la langue applicable.	zh (default)
createParameters	array<object>	La liste des paramètres de création.
	object	Le corps du paramètre.
name	string	Le nom du paramètre.	param1
value	string	La valeur du paramètre.	value1
usageParameters	array<object>	La liste des paramètres d'utilisation.
	object	Le corps du paramètre.
name	string	Le nom du paramètre.	use_param1
value	string	La valeur du paramètre.	value1
createTime	integer	L'heure de création. Unité : millisecondes.	1234
cron	string	Les informations d'entraînement en syntaxe cron (Minutes Hours DayofMonth Month DayofWeek). Une valeur vide indique qu'aucun entraînement périodique n'est effectué.	0 3 ? * 0,1,3,5 (Sunday, Monday, Wednesday, and Friday early morning
description	string	La description de l'instance.	instance descriptions
extendInfo	string	Les informations étendues au format de chaîne JSON.	{\"dataReport\":{},\"errors\":{}}
functionName	string	Le nom de la fonctionnalité.	ctr
functionType	string	Le type de fonctionnalité.	PAAS
instanceName	string	Le nom de l'instance.	ctr_test
modelType	string	Le type de modèle.	tf_checkpoint
source	string	La source de l'instance. Valeurs valides : user : instance utilisateur. builtin : instance intégrée.	user
status	string	L'état de l'instance. Valeurs valides : unavailable : aucun modèle disponible. Un entraînement est requis. available : disponible.	available
task	object	Les informations sur la tâche d'entraînement. Ce champ n'est pas affiché si aucune tâche n'existe.
dagStatus	string	L'état de la tâche. Valeurs valides : "success" : réussi. "failed" : échoué. "untrained" : en attente d'entraînement. "pending" : en cours de planification. "running" : en cours d'entraînement.	success
lastRunTime	integer	L'heure de la dernière exécution. Unité : millisecondes.	1234
versionId	integer	L'identifiant de la version.	101
modifyTime	integer
latency	integer	La latence de la requête API. Unité : millisecondes.	123

Exemples de réponses de réussite :

{
    "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
        }
    }
}

Exemples

JSON format

{
  "status": "OK",
  "httpCode": 200,
  "requestId": "68ED4E1B-92B8-5821-A886-9C90686139EB",
  "message": "instance not exist.",
  "code": "Instance.NotExist",
  "result": {
    "belongs": {
      "category": "general",
      "domain": "ecommerce",
      "language": "zh（默认）"
    },
    "createParameters": [
      {
        "name": "param1",
        "value": "value1"
      }
    ],
    "usageParameters": [
      {
        "name": "use_param1",
        "value": "value1"
      }
    ],
    "createTime": 1234,
    "cron": "0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨",
    "description": "instance descriptions",
    "extendInfo": "{\\\"dataReport\\\":{},\\\"errors\\\":{}}",
    "functionName": "ctr",
    "functionType": "PAAS",
    "instanceName": "ctr_test",
    "modelType": "tf_checkpoint",
    "source": "user",
    "status": "available",
    "task": {
      "dagStatus": "success",
      "lastRunTime": 1234
    },
    "versionId": 101,
    "modifyTime": 0
  },
  "latency": 123
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.