DescribeCloudAssistantStatus - - Alibaba Cloud Dokümantasyon Merkezi

DescribeCloudAssistantStatus çağrısı yaparak bir veya daha fazla örneğe Cloud Assistant Agent'ın kurulu olup olmadığını sorgular. Cloud Assistant kuruluysa, bu işlem ayrıca toplam komut çalıştırma sayısını, devam eden çalıştırma sayısını ve en son komut çalıştırmanın zamanını da döndürür.

Operation description

İşlem açıklaması

Bir örneğin Cloud Assistant durumunu sorgulamak için bu işlemi çağırın. CloudAssistantStatus değeri true olduğunda komutları çalıştırabilir veya dosya gönderebilirsiniz. Bu durum, özellikle yeni oluşturulan örnekler için önemlidir.
İlk sayfayı sorgularken, döndürülecek giriş sayısını sınırlamak için yalnızca MaxResults değerini ayarlayın. Yanıttaki NextToken değeri, sonraki sayfaları sorgulamak için belirteç olarak kullanılır. Sonraki sayfaları sorgularken, NextToken değerini önceki yanıttan alınan değere ayarlayın ve döndürülecek giriş sayısını sınırlamak için MaxResults değerini kullanın.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeCloudAssistantStatus

get

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Örneğin bölge kimliği. En son bölge listesini sorgulamak için DescribeRegions API'sini çağırabilirsiniz. DescribeRegions	cn-hangzhou
OSType	string	No	Örneğin işletim sistemi türü. Geçerli değerler: Windows Linux FreeBSD	Windows
PageNumber	integer	No	Not Bu parametre kullanımdan kaldırılmak üzeredir. Sayfalama işlemleri gerçekleştirmek için NextToken ve MaxResults parametrelerini kullanın.	1
PageSize	integer	No	Not Bu parametre kullanımdan kaldırılmak üzeredir. Sayfalama işlemleri gerçekleştirmek için NextToken ve MaxResults parametrelerini kullanın.	10
MaxResults	integer	No	Sayfalandırılmış bir sorgu için sayfa başına maksimum giriş sayısı. InstanceId ayarlanmışsa, bu parametre yok sayılır. Maksimum değer: 50. Varsayılan değer: 10.	10
NextToken	string	No	Sayfalama belirteci. Bu parametreyi, önceki API çağrısında döndürülen NextToken değerine ayarlayın.	AAAAAdDWBF2
InstanceId	array	No	Örnek kimliklerinin listesi.	i-bp1iudwa5b1tqa****
	string	No	ECS örnek kimliklerini ve yönetilen örnek kimliklerini içerebilen örnek kimlikleri listesi. En fazla 100 örnek kimliği belirtebilirsiniz.	i-bp1iudwa5b1tqa****

Response elements

Element	Type	Description	Example
	object
InstanceCloudAssistantStatusSet	object
InstanceCloudAssistantStatus	array<object>	Örnekler için Cloud Assistant kurulum durumu sonuçlarının koleksiyonu.
	object
ActiveTaskCount	integer	Örnekte çalışan Cloud Assistant görevlerinin sayısı.	0
CloudAssistantStatus	string	Örnekte Cloud Assistant'ın çalışıp çalışmadığını gösterir. Geçerli değerler: true: Son 2 dakika içinde bir kalp atışı algılandı. false: Son 2 dakika içinde herhangi bir kalp atışı algılanmadı.	true
CloudAssistantVersion	string	Cloud Assistant Agent'ın sürüm numarası. Cloud Assistant Agent kurulu değilse veya çalışmıyorsa bu değer boştur.	2.2.0.106
InstanceId	string	Örnek kimliği.	i-bp1iudwa5b1tqa****
InvocationCount	integer	Örnekte tamamlanan Cloud Assistant görevlerinin sayısı.	2
LastHeartbeatTime	string	Cloud Assistant'tan alınan en son kalp atışının zamanı. Bu değer, 5 saniyeye kadar rastgele bir dalgalanma ile (minimum 55 saniye, maksimum 65 saniye) yaklaşık olarak her dakika güncellenir. Zaman, UTC cinsinden ISO 8601 standardını takip eder.	2021-03-15T09:00:00Z
LastInvokedTime	string	En son komut çalıştırmasının zamanı. Zaman, UTC cinsinden ISO 8601 standardını takip eder.	2021-03-15T08:00:00Z
OSType	string	Örneğin işletim sistemi türü. Geçerli değerler: Windows Linux FreeBSD	Linux
SupportSessionManager	boolean	Örnekteki Cloud Assistant'ın oturum yönetimi özelliğini destekleyip desteklemediğini gösterir. Desteklenmiyorsa, Cloud Assistant sürümü güncel değildir. İstemciyi en son sürüme güncelleyin. Oturum yönetimini destekleyen minimum Cloud Assistant sürümleri aşağıdaki gibidir: Linux: 2.2.3.189 Windows: 2.1.3.189	true
NextToken	string	Bu çağrıda döndürülen sayfalama belirteci.	AAAAAdDWBF2
PageNumber	integer	Geçerli sayfa numarası.	1
PageSize	integer	Sayfa başına giriş sayısı.	1
RequestId	string	İstek kimliği.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Toplam örnek sayısı.	1

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	RegionId.ApiNotSupported	The api is not supported in this region.
400	MissingParam.InstanceId	The parameter instanceId is missing or empty.
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.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.
500	InternalError.Dispatch	An error occurred when you dispatched the request.
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.
403	Operation.Forbidden	The operation is not permitted.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidInstance.NotFound	The specified instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.