ListPluginStatus - - Alibaba Cloud Dokümantasyon Merkezi

Örneklerdeki Cloud Assistant eklentilerinin durumunu sorgular.

Operation description

Örneklerdeki Cloud Assistant eklentisi durumunun sorgulanabilmesi için örnekteki Cloud Assistant Agent sürümünün en az aşağıdaki sürümlerde olması gerekir:
- Linux: 2.2.3.344.
- Windows: 2.1.3.344.
Sayfalama ile ilk sayfayı sorgularken, döndürülecek giriş sayısını sınırlamak için yalnızca MaxResults parametresini ayarlayın. Yanıtta döndürülen NextToken değeri, sonraki sayfaları sorgulamak için kimlik bilgisi olarak kullanılır. Sonraki sayfaları sorgularken, NextToken parametresini önceki yanıttan alınan NextToken değerine ayarlayın ve döndürülecek giriş sayısını sınırlamak için MaxResults parametresini ayarlayı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:ListPluginStatus

get

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Bölge kimliği. En son bölge listesini sorgulamak için DescribeRegions API'sini çağırabilirsiniz.	cn-hangzhou
InstanceId	array	No	Örnek kimliği. Tek bir istekte en fazla 50 örnek belirtebilirsiniz. N için geçerli değerler: 1 ile 50 arası.
	string	No	Örnek kimliği. Tek bir istekte en fazla 50 örnek belirtebilirsiniz. N için geçerli değerler: 1 ile 50 arası.	i-bp1iudwa5b1tqa****
Name	string	No	Eklenti adı. Tam karakter kümesi desteklenir. Ad en fazla 255 karakter uzunluğunda olabilir. Bu parametreyi belirtmezseniz, örnekteki yüklü tüm eklentilerin durumu sorgulanır. Not Bu parametreyi belirtmezseniz, yalnızca bir örnek kimliği belirtebilirsiniz. Bu parametreyi belirtirseniz, örneklerdeki belirtilen eklentinin durumu sorgulanır.	testPluginName
PageNumber	integer	No	Not Bu parametre kullanımdan kaldırılmak üzeredir. Sayfalama yapmak için NextToken ve MaxResults parametrelerini kullanın.	1
PageSize	integer	No	Not Bu parametre kullanımdan kaldırılmak üzeredir. Sayfalama yapmak için NextToken ve MaxResults parametrelerini kullanın.	10
MaxResults	integer	No	Sayfalanmış bir sorgu için sayfa başına maksimum giriş sayısı. 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

Response elements

Element	Type	Description	Example
	object
InstancePluginStatusSet	object
InstancePluginStatus	array<object>	Örnek eklenti durumlarının listesi.
	array<object>	Örnek eklenti durumlarının listesi.
InstanceId	string	Örnek kimliği.	i-xxxxx
PluginStatusSet	object
PluginStatus	array<object>	Eklenti durumlarının listesi.
	object	Eklenti durumlarının listesi.
FirstHeartbeatTime	string	Cloud Assistant'ın eklenti durumunu ilk bildirdiği zaman. Zaman ISO 8601 formatındadır ve UTC olarak görüntülenir.	2020-01-19T09:15:46Z
LastHeartbeatTime	string	Cloud Assistant'ın eklenti durumunu en son bildirdiği zaman. Zaman ISO 8601 formatındadır ve UTC olarak görüntülenir.	2020-01-19T09:15:46Z
PluginName	string	Eklenti adı.	testName
PluginStatus	string	The plugin status. Valid values: NotInstalled: The plugin is not installed. Installed: The one-time plugin is installed. Running: The resident plugin is running. Stopped: The resident plugin is not running. Crashed: The plugin status is abnormal. Removed: The plugin is uninstalled. UnKnown: The status is unknown.	Running
PluginVersion	string	Eklenti sürüm numarası.	1.1
NextToken	string	Bu çağrıda döndürülen sayfalama belirteci.	AAAAAdDWBF2
PageNumber	integer	Sorgu sonucunun sayfa numarası.	1
PageSize	integer	Sayfa başına giriş sayısı.	10
RequestId	string	İstek kimliği.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	integer	Sorgu koşullarıyla eşleşen toplam kayıt sayısı.	1

Examples

Success response

JSON format

{
  "InstancePluginStatusSet": {
    "InstancePluginStatus": [
      {
        "InstanceId": "i-xxxxx",
        "PluginStatusSet": {
          "PluginStatus": [
            {
              "FirstHeartbeatTime": "2020-01-19T09:15:46Z",
              "LastHeartbeatTime": "2020-01-19T09:15:46Z",
              "PluginName": "testName",
              "PluginStatus": "Running",
              "PluginVersion": "1.1"
            }
          ]
        }
      }
    ]
  },
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 1
}

Error codes

HTTP status code	Error code	Error message
400	RegionId.ApiNotSupported	The api is not supported in this region.
400	InvalidParam.PageNumber	The specified parameter PageNumber is invalid.
400	InvalidParam.PageSize	The specified parameter PageSize is invalid.
400	PluginName.MissingValue	The plugin name must be specified when the number of InstanceIds is not 1.
400	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.
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.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	Operation.Forbidden	The operation is not permitted.
404	InvalidInstance.NotFound	The specified instance does not exist.
404	InvalidPluginName.NotFound	The specified plugin name does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.