DescribeInstances - - Alibaba Cloud Dokümantasyon Merkezi

Bir veya daha fazla örneğin ayrıntılarını sorgular.

Operation description

API çağrı sıklığı: Saniyede 800 çağrı.

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

ens:DescribeInstances

list

*Instance

acs:ens:*:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
EnsRegionId	string	No	Bölge kimliği.	cn-beijing-cmcc
InstanceId	string	No	Örnek kimliği.	i-5iqczfxps7csjrxeca****
EnsRegionIds	string	No	Uç bölge kimliklerinin listesi. Bu parametre, virgülle (,) ayrılmış en fazla 100 kimlik içeren biçimlendirilmiş bir JSON dizisidir.	["cn-suzhou-telecom","cn-chengdu-telecom"]
InstanceIds	string	No	Örnek kimliklerinin listesi. Bu parametre, virgülle (,) ayrılmış en fazla 100 kimlik içeren biçimlendirilmiş bir JSON dizisidir.	["i-5iqczfxps7csjrxeca07**", "i-5iqczfxps7csjrxeca07**"]
InstanceName	string	No	Örnek adı.	TestName
ImageId	string	No	Görüntü kimliği.	centos_6_08_64_20G_alibase_****
PageNumber	integer	No	Örnek durumu listesinin sayfa numarası. Değer 1'den başlar.	1
PageSize	string	No	Sayfalanmış sorgu için sayfa başına giriş sayısı. Maksimum değer: 100.	10
Status	string	No	Örnek durumu. Geçerli değerler: Running: Çalışıyor. Stopped: Durduruldu. Expired: Süresi doldu.	Running
OrderByParams	string	No	JSON biçimindeki sıralama parametresi.	{ "InstanceNameSort": "asc", "ExpireTimeSort": "asc", "CreationTimeSort": "desc", "EnsRegionId": "desc" }
EnsServiceId	string	No	Edge Node Service kimliği. Uç hizmeti altında oluşturulan örnekleri sorgulamak için bu kimliği kullanabilirsiniz.	ens-20190730202316s****
InstanceResourceType	string	No	Filtre türü. Geçerli değerler:	EnsService
SearchKey	string	No	Arama anahtar kelimesi. ip, InstanceName ve InstanceId gibi parametreleri destekler.	Joshua
NetworkId	string	No	Ağ kimliği.	n-2zeuphj08tt7q3brd****
VSwitchId	string	No	vSwitch kimliği.	vsw-2zeh0r1pabwtg6wcs****
SecurityGroupId	string	No	Güvenlik grubu kimliği.	sg-5kyicq2kfcapxrdds6tar7jqb
IntranetIp	string	No	Dahili IP adresi.	47.100.XX.XX
Tags	array<object>	No	Kaynak etiketleri. Bu işlem etiket bilgilerini döndürmez. Bu parametreyi etiket kategorisindeki API'lerle birlikte kullanın.
	object	No	Örneğin etiket kümesi. Bu işlem etiket bilgilerini döndürmez. Bu parametreyi etiket kategorisindeki API'lerle birlikte kullanın.
Key	string	No	Örneğin etiket anahtarı. N için geçerli değerler: 1 ile 20 arası.	tag
Value	string	No	Örneğin etiket değeri. N için geçerli değerler: 1 ile 20 arası.	2
InstanceType	string	No	Örnek türü.	ens.se1.tiny
ServiceStatus	array	No	Örneğin iş durumu; bu durum, örneğin gerçek çalışma durumunu temsil etmez.
	string	No	Örneğin hizmet durumu. Bu durum, örneğin gerçek çalışma durumunu temsil etmez. Expired Arrears (vadesi geçmiş ödeme)	Expired
EipAddresses	array	No	Örnekleri filtrelemek için kullanılan EIP adreslerinin listesi.
	string	No	Örnekleri filtrelemek için kullanılan EIP adreslerinin listesi.	120.XX.XX.10
VpdId	string	No	VPD ağ kimliği.	vpd-5s7xxxxxxx
VpdVSwitchId	string	No	VPD vSwitch kimliği.	vsw-5s7xxxxxxx

Response elements

Element	Type	Description	Example
	object
Code	integer	Döndürülen işlem kodu. 0 değeri başarılı olduğunu gösterir.	0
PageSize	integer	İstekte belirtilen sayfa başına giriş sayısı.	60
PageNumber	integer	Örnek listesinin sayfa numarası.	1
RequestId	string	İstek kimliği.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Döndürülen toplam örnek sayısı.	2
Instances	object
Instance	array<object>	Örnek bilgilerini içeren InstanceAttributesType nesnelerinden oluşan bir dizi.
	array<object>	Yanıt şeması.
CreationTime	string	Örneğin oluşturulduğu zaman. Saat, ISO 8601 standardında ve UTC biçiminde görüntülenir. Biçim: yyyy-MM-ddTHH:mm:ssZ.	2019-07-26T06:40:43Z
Status	string	Durum. Geçerli değerler: Running: Çalışıyor. Expired: Süresi dolmuş. Stopped: Durdurulmuş.	Running
SpecName	string	Örnek teknik özellik kodu.	ens.sn1.stiny
InstanceTypeFamily	string	Örnek ailesi kategorisi. Geçerli değerler: x86_vm: X86 bilişim x86_pm: X86 fiziksel makine x86_bmi: X86 çıplak metal x86_bm: Akıllı NIC çıplak metal pc_bmi: Heterojen çıplak metal pc_vm: Heterojen sanal makine arm_bmi: ARM bilişim	x86_vm
InstanceResourceType	string	Örnek türü. Geçerli değerler: EnsInstance: Bağımsız olarak satın alınan örnek. EnsService: Edge Node Service örneği. BuildMachine: Görüntü oluşturma makinesi. EnsPostPaidInstance: Bağımsız olarak satın alınan kullandıkça öde örneği.	EnsService
HostName	string	Örneğin ana bilgisayar adı.	testHostName
InstanceId	string	Örnek kimliği.	i-instanc****
InternetMaxBandwidthIn	integer	Maksimum aşağı yönlü bant genişliği. Birim: Mbit/s.	40
InternetMaxBandwidthOut	integer	Maksimum yukarı yönlü bant genişliği. Birim: Mbit/s.	100
EnsRegionId	string	Örneğin bulunduğu bölgenin kimliği.	cn-hangzhou-telecom
Cpu	string	vCPU çekirdek sayısı.	2
ExpiredTime	string	Sona erme zamanı. Saat, ISO 8601 standardında ve UTC biçiminde görüntülenir. Biçim: yyyy-MM-ddTHH:mm:ssZ.	2119-07-13T02:38:57Z
InstanceName	string	Örnek adı.	i-5itef0f28t17bcdw9deu6meub
Disk	integer	Toplam disk boyutu. Birim: MiB.	71680
OSName	string	Görüntü adı.	centos 6.8 x86_64
Memory	integer	Bellek boyutu. Birim: MB.	2048
ImageId	string	Görüntü kimliği.	m-****
DataDisk	object
DataDisk	array<object>	Veri bulut diski bilgileri.
	object	Yanıt şeması.
device_type	string	Category genişletilmiş alanı. Geçerli değerler: file: Yerel disk. pangu: Ultra bulut diski. local_hdd: Yerel HDD.	pangu
disk_type	string	Bulut diski veya yerel diskin türü. Geçerli değerler:	system
Size	integer	Disk boyutu. Birim: MiB.	51200
DiskName	string	Disk adı.	DiskName
uuid	string	UUID.	5431f898-1323-4e64-8ce1-6cad50ed****
storage	integer	Disk kapasitesi. Birim: MiB.	20480
DiskId	string	Disk kimliği.	d-5ip4c2dhmas0vjd5u1r****
Category	string	Bulut diski veya yerel diskin türü. Geçerli değerler: file: Yerel disk. pangu: Ultra bulut diski. local_hdd: Yerel HDD.	file
name	string	Disk adı.	name
DiskSize	integer	Disk boyutu. Birim: GiB.	100
EncryptKeyId	string	Bulut diski tarafından kullanılan KMS anahtar kimliği.	0e478b7a-4262-4802-b8cb-00d3fxxxxx
Encrypted	boolean	Bulut diskinin şifrelenip şifrelenmediğini gösterir.	true
PublicIpAddresses	object
PublicIpAddress	array<object>	Genel IP adresi bilgileri.
	object	Genel IP adresi bilgileri.
Ip	string	IP adresi.	119.147.xx.xx
GateWay	string	Ağ geçidi.	119.147.xx.xx
Isp	string	İnternet servis sağlayıcısı (ISP) bilgileri.	unicom
PrivateIpAddresses	object
PrivateIpAddress	array<object>	Örneğin özel IP adresi bilgileri.
	object
Ip	string	IP adresi.	119.147.xx.xx
GateWay	string	Ağ geçidi.	119.147.xx.xx
Isp	string	İnternet servis sağlayıcısı (ISP) bilgileri.	cmcc
SecurityGroupIds	object
SecurityGroupId	array	Güvenlik grubu kimliği.
	string	Güvenlik grubu kimliği.	sg-5kyicq2kfcapxrdds6ta****
InnerIpAddress	object
IpAddress	array	Örneğin dahili IP adresi.
	string	Örneğin dahili IP adresi.	10.170.xx.xx
PublicIpAddress	object
IpAddress	array	Genel IP adresi.
	string	Genel IP adresi.	119.147.xx.xx
SystemDisk	object	Sistem diski bilgileri.
device_type	string	Category genişletilmiş alanı. Geçerli değerler: file: Yerel disk. pangu: Ultra bulut diski. local_hdd: Yerel HDD.	pangu
disk_type	string	Bulut diski veya yerel diskin türü. Geçerli değerler:	system
Size	integer	Disk boyutu. Birim: MiB.	51200
DiskName	string	Disk adı.	DiskName
uuid	string	UUID.	5431f898-1323-4e64-8ce1-6cad50ed****
storage	integer	Disk kapasitesi. Birim: MiB.	20480
DiskId	string	Disk kimliği.	d-5ip4c2dhmas0rn7rt0p9****
Category	string	Bulut diski veya yerel diskin kategorisi. Geçerli değerler: file: Yerel disk. pangu: Ultra bulut diski. local_hdd: Yerel HDD.	file
name	string	Disk adı.	DiskName
NetworkAttributes	object	Ağ özniteliği bilgileri.
NetworkId	string	Ağ kimliği.	n-2zeuphj08tt7q3brd****
VSwitchId	string	vSwitch kimliği.	vsw-2zeh0r1pabwtg6wcs****
PrivateIpAddress	object
IpAddress	array	Örneğin özel IP adresi bilgileri.
	string	Örneğin özel IP adresi. Dahili bir IP adresi belirtirseniz, yalnızca bir adres belirtilebilir. IP adresi, vSwitch'in (VSwitchId) CIDR bloğunda kullanılabilir bir adres olmalıdır.	172.17..
Tags	object
Tags	array<object>	Örneğin etiketleri. Önemli Bu işlem, etiket bilgilerinin döndürülmesini desteklemez. Bu işlemle birlikte Etiketler kategorisindeki API'leri kullanın.
	object	Etiket bilgileri. Önemli Bu işlem, etiket bilgilerinin döndürülmesini desteklemez. Bunun yerine "Etiketler" kategorisindeki API işlemlerini kullanın.
TagValue	string	Etiket değeri.	value1
TagKey	string	Örneğin etiket anahtarı.	key1
AutoReleaseTime	string	ISO 8601 UTC biçiminde otomatik serbest bırakma zamanı. Biçim: YYYY-MM-DDTHH:mm:ssZ.	2023-06-28T14:38:52Z
SpotStrategy	string	Spot örnek stratejisi.	NoSpot
KeyPairName	string	Anahtar çifti adı.	TestKeyPairName
NetworkInterfaces	object
NetworkInterfaces	array<object>	Ağ arabirimi kartı (NIC) bilgileri koleksiyonu.
	array<object>	Ağ arabirimi kartı (NIC) bilgileri koleksiyonu.
Type	string	Ağ arabirimi kartının (NIC) türü. Geçerli değerler:	Primary
MacAddress	string	Ağ arabirimi kartının (NIC) MAC adresi.	00:16:XXX:XXX:60:0a
PrimaryIpAddress	string	Birincil özel IP adresi.	10.XXX.XXX.25
NetworkInterfaceId	string	Ağ arabirimi denetleyicisinin (NIC) kimliği.	eni-53afk8a0t5lklbi8m7j8iczdg
PrivateIpSets	object
PrivateIpSet	array<object>	PrivateIpSet nesnelerinin koleksiyonu.
	object	PrivateIpSet nesnelerinin koleksiyonu.
PrivateIpAddress	string	Özel IP adresi.	192.XXX.XXX.130
Primary	boolean	IP adresinin birincil özel IP adresi olup olmadığını gösterir. Geçerli değerler:	true
Ipv6Sets	object
Ipv6Set	array<object>	Ağ arabirimi denetleyicisinin (NIC) esnek ağ arabirimlerine (ENI) ayrılmış IPv6 adresleri.
	object	Ağ arabirimi denetleyicisinin (NIC) esnek ağ arabirimlerine (ENI) ayrılmış IPv6 adresleri.
Ipv6Address	string	Ağ arabirimi denetleyicisinin (NIC) esnek ağ arabirimlerine (ENI) ayrılmış IPv6 adresi.	2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6
VpdVSwitchId	string	VPD vSwitch kimliği.	vsw-5s7xxxxxxx
VpdId	string	VPD ağ kimliği.	vpd-5s7xxxxxxx
ServiceStatus	string	Örneğin hizmet durumu. Bu durum, örneğin gerçek çalışma durumunu temsil etmez.	Expired
DeletionProtection	boolean	Örnek için silme korumasının etkinleştirilip etkinleştirilmediğini gösterir.

Examples

Success response

JSON format

{
  "Code": 0,
  "PageSize": 60,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 2,
  "Instances": {
    "Instance": [
      {
        "CreationTime": "2019-07-26T06:40:43Z",
        "Status": "Running",
        "SpecName": "ens.sn1.stiny",
        "InstanceTypeFamily": "x86_vm",
        "InstanceResourceType": "EnsService",
        "HostName": "testHostName",
        "InstanceId": "i-instanc****",
        "InternetMaxBandwidthIn": 40,
        "InternetMaxBandwidthOut": 100,
        "EnsRegionId": "cn-hangzhou-telecom",
        "Cpu": "2",
        "ExpiredTime": "2119-07-13T02:38:57Z",
        "InstanceName": "i-5itef0f28t17bcdw9deu6meub",
        "Disk": 71680,
        "OSName": "centos 6.8 x86_64",
        "Memory": 2048,
        "ImageId": "m-****",
        "DataDisk": {
          "DataDisk": [
            {
              "device_type": "pangu",
              "disk_type": "system",
              "Size": 51200,
              "DiskName": "DiskName",
              "uuid": "5431f898-1323-4e64-8ce1-6cad50ed****",
              "storage": 20480,
              "DiskId": "d-5ip4c2dhmas0vjd5u1r****",
              "Category": "file",
              "name": "name",
              "DiskSize": 100,
              "EncryptKeyId": "0e478b7a-4262-4802-b8cb-00d3fxxxxx",
              "Encrypted": true
            }
          ]
        },
        "PublicIpAddresses": {
          "PublicIpAddress": [
            {
              "Ip": "119.147.xx.xx",
              "GateWay": "119.147.xx.xx",
              "Isp": "unicom"
            }
          ]
        },
        "PrivateIpAddresses": {
          "PrivateIpAddress": [
            {
              "Ip": "119.147.xx.xx",
              "GateWay": "119.147.xx.xx",
              "Isp": "cmcc"
            }
          ]
        },
        "SecurityGroupIds": {
          "SecurityGroupId": [
            "sg-5kyicq2kfcapxrdds6ta****"
          ]
        },
        "InnerIpAddress": {
          "IpAddress": [
            "10.170.xx.xx"
          ]
        },
        "PublicIpAddress": {
          "IpAddress": [
            "119.147.xx.xx"
          ]
        },
        "SystemDisk": {
          "device_type": "pangu",
          "disk_type": "system",
          "Size": 51200,
          "DiskName": "DiskName",
          "uuid": "5431f898-1323-4e64-8ce1-6cad50ed****",
          "storage": 20480,
          "DiskId": "d-5ip4c2dhmas0rn7rt0p9****",
          "Category": "file",
          "name": "DiskName"
        },
        "NetworkAttributes": {
          "NetworkId": "n-2zeuphj08tt7q3brd****",
          "VSwitchId": "vsw-2zeh0r1pabwtg6wcs****",
          "PrivateIpAddress": {
            "IpAddress": [
              "172.17.**.**"
            ]
          }
        },
        "Tags": {
          "Tags": [
            {
              "TagValue": "value1",
              "TagKey": "key1"
            }
          ]
        },
        "AutoReleaseTime": "2023-06-28T14:38:52Z",
        "SpotStrategy": "NoSpot",
        "KeyPairName": "TestKeyPairName",
        "NetworkInterfaces": {
          "NetworkInterfaces": [
            {
              "Type": "Primary",
              "MacAddress": "00:16:XXX:XXX:60:0a",
              "PrimaryIpAddress": "10.XXX.XXX.25",
              "NetworkInterfaceId": "eni-53afk8a0t5lklbi8m7j8iczdg",
              "PrivateIpSets": {
                "PrivateIpSet": [
                  {
                    "PrivateIpAddress": "192.XXX.XXX.130",
                    "Primary": true
                  }
                ]
              },
              "Ipv6Sets": {
                "Ipv6Set": [
                  {
                    "Ipv6Address": "2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6"
                  }
                ]
              },
              "VpdVSwitchId": "vsw-5s7xxxxxxx",
              "VpdId": "vpd-5s7xxxxxxx"
            }
          ]
        },
        "ServiceStatus": "Expired",
        "DeletionProtection": false
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter domainName that is mandatory for processing this request is not supplied.
400	InstanceIdNotFound	The input parameter instancdId that is not found.	The specified instance ID does not exist.
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.