GetForecastAgentInstance - Data Management - Centro de documentación de Alibaba Cloud

Obtiene la lista de agentes de pronóstico.

Descripción de la operación

Nota: Eliminar una instancia solo la quita de la lista de instancias de DMS. Esta operación no elimina ni desactiva su 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

dms:GetForecastAgentInstance

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DataRegion	string	No	La región donde reside el lago de datos.	cn-hangzhou

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
HttpStatusCode	integer	El código de estado HTTP.	200
Success	boolean	Indica si la solicitud se realizó correctamente.	true
ErrorCode	string	El código de error.	UnknownError
Message	string	El mensaje de error devuelto si la solicitud falló.	UnknownError
Root	object	La información relacionada con Dify.
Exists	boolean	Indica si el nombre del presupuesto ya existe.	True
Instances	array<object>	El alias de la instancia.
	object	Si el origen del permiso es una política de acceso, este campo contiene el nombre de la política de acceso y las operaciones que el usuario tiene permitido realizar.
InstanceUuid	string	El identificador único del cliente de respaldo de base de datos en el servidor de destino para la restauración. Nota Puede llamar a la operación DescribeUniBackupDatabase para obtener este parámetro.	***
RegionId	string	La región del servicio DMS. Para consultar los valores válidos, consulte la descripción del parámetro RegionID. Nota Seleccione la región más cercana a su aplicación.	cn-hangzhou
Status	string	La condición de filtro para los grupos de estado de ejecución de tareas.	ON_LINE
CurrentStep	string	El número de paso actual de la tarea.	PRE_CHECK
TaskId	string	El ID de la tarea.	201806739596800
FailureMessage	string	El mensaje de fallo. Este campo se devuelve si la creación falló.	forecast agent provision failed, id
ImageVersion	string	La versión de la imagen.	xuanwoali69a-80C320G-20250606-slave0527

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "HttpStatusCode": 200,
  "Success": true,
  "ErrorCode": "UnknownError",
  "Message": "UnknownError",
  "Root": {
    "Exists": true,
    "Instances": [
      {
        "InstanceUuid": "***",
        "RegionId": "cn-hangzhou",
        "Status": "ON_LINE",
        "CurrentStep": "PRE_CHECK",
        "TaskId": "201806739596800",
        "FailureMessage": "forecast agent provision failed, id",
        "ImageVersion": "xuanwoali69a-80C320G-20250606-slave0527"
      }
    ]
  }
}

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.