DescribeCloudAssistantStatus - Elastic Compute Service - Centro de documentación de Alibaba Cloud

Consulta si Cloud Assistant Agent está instalado en una o más instancias. Si Cloud Assistant está instalado, la operación también devuelve el número total de ejecuciones de comandos, el número de ejecuciones en curso y la hora de la ejecución de comando más reciente.

Descripción de la operación

Esta operación consulta el estado de Cloud Assistant de una instancia. Cuando CloudAssistantStatus sea true, ejecute comandos o envíe archivos. Esto es especialmente importante para las instancias recién creadas.
Al consultar la primera página de forma paginada, establezca solo MaxResults para limitar el número de entradas que se devolverán. El valor de NextToken de la respuesta se usa como credencial para consultar las páginas siguientes. Al consultar las páginas siguientes de forma paginada, establezca NextToken en el valor obtenido de la respuesta anterior y establezca MaxResults para limitar el número de entradas que se devolverán.

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

ecs:DescribeCloudAssistantStatus

get

*Instance.

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región de la instancia. Puede llamar a DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
OSType	string	No	El tipo de sistema operativo de la instancia. Valores válidos: Windows Linux FreeBSD	Windows
PageNumber	integer	No	Nota Este parámetro está a punto de quedar obsoleto. Use NextToken y MaxResults para paginar los resultados.	1
PageSize	integer	No	Nota Este parámetro está a punto de quedar obsoleto. Use NextToken y MaxResults para paginar los resultados.	10
MaxResults	integer	No	El número máximo de entradas por página para una consulta paginada. Si se especifica InstanceId, este parámetro se ignora. Valor máximo: 50. Valor predeterminado: 10.	10
NextToken	string	No	El token de paginación. Establezca este parámetro en el valor de NextToken devuelto en la llamada a la API anterior.	AAAAAdDWBF2
InstanceId	array	No	La lista de ID de instancias.	i-bp1iudwa5b1tqa****
	string	No	La lista de ID de instancias, que puede incluir ID de instancias de ECS e ID de instancias administradas. Puede especificar hasta 100 ID de instancias.	i-bp1iudwa5b1tqa****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
InstanceCloudAssistantStatusSet	object
InstanceCloudAssistantStatus	array<object>	La colección de resultados del estado de instalación de Cloud Assistant de las instancias.
	object
ActiveTaskCount	integer	El número de tareas de Cloud Assistant en ejecución en la instancia.	0
CloudAssistantStatus	string	Indica si Cloud Assistant se está ejecutando en la instancia. Valores válidos: true: se detectó un latido en los últimos 2 minutos. false: no se detectó ningún latido en los últimos 2 minutos.	true
CloudAssistantVersion	string	El número de versión de Cloud Assistant Agent. Este valor está vacío si Cloud Assistant Agent no está instalado o no se está ejecutando.	2.2.0.106
InstanceId	string	El ID de la instancia.	i-bp1iudwa5b1tqa****
InvocationCount	integer	El número de tareas de Cloud Assistant completadas en la instancia.	2
LastHeartbeatTime	string	La hora del latido más reciente de Cloud Assistant. Este valor se actualiza aproximadamente cada minuto con una variación aleatoria de hasta 5 segundos (mínimo 55 segundos, máximo 65 segundos). La hora sigue el estándar ISO 8601 en UTC.	2021-03-15T09:00:00Z
LastInvokedTime	string	La hora de la ejecución de comando más reciente. La hora sigue el estándar ISO 8601 en UTC.	2021-03-15T08:00:00Z
OSType	string	El tipo de sistema operativo de la instancia. Valores válidos: Windows Linux FreeBSD	Linux
SupportSessionManager	boolean	Indica si Cloud Assistant en la instancia admite la función de administración de sesiones. Si no se admite, la versión de Cloud Assistant está desactualizada. Actualice el cliente a la última versión. Las versiones mínimas de Cloud Assistant que admiten la administración de sesiones son las siguientes: Linux: 2.2.3.189 Windows: 2.1.3.189	true
NextToken	string	El token de paginación devuelto en esta llamada.	AAAAAdDWBF2
PageNumber	integer	El número de la página actual.	1
PageSize	integer	El número de entradas por página.	1
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	El número total de instancias.	1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "InstanceCloudAssistantStatusSet": {
    "InstanceCloudAssistantStatus": [
      {
        "ActiveTaskCount": 0,
        "CloudAssistantStatus": "true",
        "CloudAssistantVersion": "2.2.0.106",
        "InstanceId": "i-bp1iudwa5b1tqa****",
        "InvocationCount": 2,
        "LastHeartbeatTime": "2021-03-15T09:00:00Z",
        "LastInvokedTime": "2021-03-15T08:00:00Z",
        "OSType": "Linux",
        "SupportSessionManager": true
      }
    ]
  },
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	RegionId.ApiNotSupported	The api is not supported in this region.	La operación de API no es compatible en la región especificada. Compruebe si el valor del parámetro RegionId es correcto.
400	MissingParam.InstanceId	The parameter instanceId is missing or empty.	El ID de la instancia está vacío.
400	InvalidParam.PageSize	The specified parameter is invalid.
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.	El parámetro NextToken especificado no es válido.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	El parámetro MaxResults especificado no es válido.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	Ocurrió un error al enviar la solicitud. Inténtelo de nuevo más tarde.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.	El número de instancias de destino excede el límite superior.
403	Operation.Forbidden	The operation is not permitted.	La operación no está permitida.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	El RegionId especificado no existe. Verifique si el producto está disponible en esta región.
404	InvalidInstance.NotFound	The specified instance does not exist.	La instancia especificada no existe.

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.