DescribeInstanceStatus - - Alibaba Cloud Dokümantasyon Merkezi

Operation description

Bir ECS örneğinin yaşam döngüsü durumları hakkında bilgi için Örnek yaşam döngüsü konusuna bakın.

Örnek istekler

Belirli bir bölgedeki ECS örneklerini ve örneklerin durumunu sorgulama. Örnek istek:

"RegionID": "cn-hangzhou"

Belirli bir bölgenin bir kullanılabilirlik bölgesindeki ECS örneklerini ve örneklerin durumunu sorgulama. Örnek istek:

"RegionID": "cn-hangzhou",
"ZoneID": "cn-hangzhou-a"

Örnek kimliğine göre belirli bir bölgedeki bir ECS örneğinin durumunu sorgulama. Örnek istek:

"RegionID": "cn-hangzhou",
"InstancesID": ["i-bp1f7c1zqp999zvp****", "i-bp1dqjv36biueg61****"]

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:DescribeInstanceStatus

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Örneklerin bölge kimliği. En son bölge listesini sorgulamak için DescribeRegions işlemini çağırabilirsiniz.	cn-hangzhou
ZoneId	string	No	Örneklerin kullanılabilirlik bölgesi kimliği. En son kullanılabilirlik bölgesi listesini sorgulamak için DescribeZones işlemini çağırabilirsiniz.	cn-hangzhou-d
ClusterId	string	No	ECS örneklerinin ait olduğu kümenin kimliği. Not Bu parametre kullanımdan kaldırılmıştır. Bu parametreyi kullanmamanızı öneririz.	cls-bp67acfmxazb4p****
PageNumber	integer	No	Sayfa numarası. Sayfalar 1. sayfadan başlar. Varsayılan değer: 1.	1
PageSize	integer	No	Her sayfadaki giriş sayısı. Geçerli değerler: 1 ila 50. Varsayılan değer: 10.	10
InstanceId	array	No	ECS örneklerinin kimlikleri. 1 ila 100 arası örnek kimliği belirtebilirsiniz. Örnek: ["i-bp1j4i2jdf3owlhe**", "i-bp1j4i2jdf3o1234**"].	i-bp1j4i2jdf3owlhe****
	string	No	ECS örneğinin kimliği.	i-bp1j4i2jdf3owlhe****

Response elements

Element	Type	Description	Example
	object
PageSize	integer	Her sayfadaki giriş sayısı.	1
RequestId	string	İstek kimliği.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	Sayfa numarası.	1
TotalCount	integer	Toplam örnek sayısı.	58
InstanceStatuses	object
InstanceStatus	array<object>	ECS örneklerinin kimlikleri ve durumu.
	object
Status	string	Örneğin durumu. Geçerli değerler: Pending: Örnek oluşturuluyor. Running: Örnek çalışıyor. Starting: Örnek başlatılıyor. Stopping: Örnek durduruluyor. Stopped: Örnek durduruldu.	Running
InstanceId	string	Örneğin kimliği.	i-bp1j4i2jdf3owlhe****

Examples

Success response

JSON format

{
  "PageSize": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 58,
  "InstanceStatuses": {
    "InstanceStatus": [
      {
        "Status": "Running",
        "InstanceId": "i-bp1j4i2jdf3owlhe****"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidParameter.TooManyInstanceIds	Instance ids cannot be more than 100.	InstanceIds cannot be more than 100.
403	Abs.InvalidInstanceIds.MalFormed	The specified instanceIds is not valid.	The specified instance ID is invalid.
404	InvalidZoneId.NotFound	The ZoneId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.