DescribeInstances - API Gateway

Menampilkan detail satu atau beberapa instance bersama (shared) atau khusus (dedicated) dalam suatu wilayah.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:DescribeInstances

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	No	ID instans. Jika Anda tidak menentukan parameter ini, semua instans akan diambil.	api-shared-vpc-001
Language	string	No	Bahasa respons. Deskripsi kebijakan sistem akan dikembalikan dalam bahasa ini. en: Bahasa Inggris. zh: Bahasa Tionghoa. ja: Bahasa Jepang.	zh
InstanceType	string	No
EnableTagAuthorization	boolean	No	Menunjukkan apakah otorisasi berbasis tag diaktifkan.	false
Tag	array<object>	No	Tag yang dilampirkan pada instans.
	object	No	Tag yang dilampirkan pada instans.
Key	string	No	Kunci tag.	key1
Value	string	No	Nilai tag.	value

Elemen respons

Element	Type	Description	Example
	object
PageNumber	integer	Nomor halaman saat ini.	1
RequestId	string	ID permintaan.	CEB6EC62-B6C7-5082-A45A-45A204724AC2
PageSize	integer	Jumlah entri per halaman.	10
TotalCount	integer	Total jumlah entri.	1
Instances	object
InstanceAttribute	array<object>	Detail instans.
	array<object>	Detail instans.
Status	string	Status instans.	RUNNING
VpcSlbIntranetEnable	boolean	Menunjukkan apakah SLB akses internal untuk VPC diaktifkan.	true
ClassicEgressAddress	string	Alamat IP egress jaringan klasik.	10.0.0.1
ZoneLocalName	string	Nama zona.	Multi-Availability Zone 3(b,c,a)
UserVpcId	string	ID VPC pengguna.	vpc-t*hxyu9**t0g4
VpcIntranetEnable	boolean	Menunjukkan apakah VPC akses internal diaktifkan.	true
VpcOwnerId	integer	ID Akun Alibaba Cloud tempat VPC tersebut berada.	1408453217640291****
InstanceId	string	ID instans.	api-shared-vpc-020
InstanceRpsLimit	integer	Batas catatan per detik (RPS) instans.	500
InstanceType	string	Tipe instans. Nilai yang valid: VPC_SHARED: instans bersama (VPC) VPC_DEDICATED: instans khusus (VPC)	VPC_SHARED
RegionId	string	ID wilayah tempat instans berada.	cn-beijing
InstanceSpec	string	Spesifikasi instans.	api.s1.small
InstanceChargeType	string	Metode penagihan instans. Nilai yang valid: PrePaid: subscription. PayAsYouGo: pay-as-you-go.	PrePaid
HttpsPolicies	string	Kebijakan keamanan HTTPS.	HTTPS2_TLS1_2
VpcEgressAddress	string	Blok CIDR egress VPC akses internal.	100.104.254.0/26
NewVpcEgressAddress	string	Blok CIDR egress baru VPC akses internal.	100.104.253.0/26
EgressIpv6Enable	boolean	Menunjukkan apakah egress IPv6 diaktifkan.	true
ExpiredTime	string	Waktu kedaluwarsa instans.	1659801600000
InstanceName	string	Nama instans.	test
ZoneId	string	ID zona.	cn-hangzhou-MAZ5(g,h)
SupportIpv6	boolean	Menunjukkan apakah IPv6 didukung.	true
InternetEgressAddress	string	Alamat IP egress publik.	47.241.89.244
CreatedTime	string	Waktu pembuatan instans.	2021-10-22 15:36:53.0
InstanceSpecAttributes	object
SpecAttribute	array<object>	Detail spesifikasi instans.
	object	Detail spesifikasi instans.
Value	string	Nilai spesifikasi.	99.95%
LocalName	string	Nama variabel.	SLA
UserVswitchId	string	ID vSwitch pengguna.	vsw-t4*ehd7q**i2f
AclName	string	Nama daftar kontrol akses (ACL).	test
AclType	string	Tipe ACL. Nilai yang valid: black: blacklist white: whitelist	white
AclStatus	string	Menunjukkan apakah ACL diaktifkan. Nilai yang valid: on: diaktifkan. off: dinonaktifkan.	on
AclId	string	ID ACL.	acl-uf6f9zfxfxtp5j9ng3yv4
IntranetSegments	string	Blok CIDR jaringan internal dari mana instans API Gateway dapat diakses.	[\"172.36.0.0/16\",\"172.31.16.0/20\"]
IPV6AclName	string	Nama ACL IPv6.	testIPV6
IPV6AclId	string	ID ACL IPv6.	acl-124resFfs235
IPV6AclType	string	Tipe ACL IPv6. Nilai yang valid: black: blacklist white: whitelist	black
IPV6AclStatus	string	Menunjukkan apakah ACL IPv6 diaktifkan. Nilai yang valid: on: diaktifkan. off: dinonaktifkan.	on
DedicatedInstanceType	string	Tipe instans khusus. Nilai yang valid: vpc_connect: instans khusus terhubung VPC normal: instans khusus berbasis jaringan klasik	vpc_connect
InstanceCidrBlock	string	Blok CIDR tempat instans khusus berada. 172.16.0.0/12 192.168.0.0/16	192.168.0.0/16
ConnectVpcId	string	ID VPC pengguna yang terhubung ke instans khusus terhubung VPC.	vpc-m5eo7khlb4h4f8y9egsdg
NetworkInterfaceAttributes	object
NetworkInterfaceAttribute	array<object>	Detail antarmuka jaringan VPC pengguna yang terhubung ke instans khusus.
	object	Detail antarmuka jaringan VPC pengguna yang terhubung ke instans khusus.
VswitchId	string	ID vSwitch.	vsw-2zeqals6rbj51bhjn8b89
SecurityGroupId	string	ID grup keamanan. Layanan dalam grup keamanan yang sama dapat saling mengakses.	sg-2zeehz13zcyj1kfk3o85
CidrBlock	string	Blok CIDR vSwitch.	192.168.17.0/24
ZoneId	string	ID zona.	cn-shenzhen-d
InstanceClusterId	string	ID kluster instans khusus yang mengelola instans khusus ini.	apigateway-cluster-sh-1523cafbgffd
MaintainStartTime	string	Waktu mulai jendela pemeliharaan. Waktu dalam format HH:mmZ dan dalam UTC.	22:00Z
MaintainEndTime	string	Waktu akhir jendela pemeliharaan. Waktu dalam format HH:mmZ dan dalam UTC.	01:00Z
ConnectCidrBlocks	string	Blok CIDR internal VPC pengguna yang dapat diakses oleh instans khusus terhubung VPC.	[\"172.16.0.0/24\",\"172.16.1.0/24\"]
PrivateDnsList	object
PrivateDns	array	Daftar nama domain internal.
	string	Nama domain internal.	www.private.com
Tags	object
TagInfo	array<object>	Daftar tag.
	object
Key	string	Kunci tag.	Cookie
Value	string	Nilai tag.	240

Contoh

Respons sukses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "CEB6EC62-B6C7-5082-A45A-45A204724AC2",
  "PageSize": 10,
  "TotalCount": 1,
  "Instances": {
    "InstanceAttribute": [
      {
        "Status": "RUNNING",
        "VpcSlbIntranetEnable": true,
        "ClassicEgressAddress": "10.0.0.1",
        "ZoneLocalName": "Multi-Availability Zone 3(b,c,a)",
        "UserVpcId": "vpc-t***hx****yu9****t0g4",
        "VpcIntranetEnable": true,
        "VpcOwnerId": 0,
        "InstanceId": "api-shared-vpc-020",
        "InstanceRpsLimit": 500,
        "InstanceType": "VPC_SHARED",
        "RegionId": "cn-beijing",
        "InstanceSpec": "api.s1.small",
        "InstanceChargeType": "PrePaid",
        "HttpsPolicies": "HTTPS2_TLS1_2",
        "VpcEgressAddress": "100.104.254.0/26",
        "NewVpcEgressAddress": "100.104.253.0/26",
        "EgressIpv6Enable": true,
        "ExpiredTime": "1659801600000",
        "InstanceName": "test",
        "ZoneId": "cn-hangzhou-MAZ5(g,h)",
        "SupportIpv6": true,
        "InternetEgressAddress": "47.241.89.244",
        "CreatedTime": "2021-10-22 15:36:53.0",
        "InstanceSpecAttributes": {
          "SpecAttribute": [
            {
              "Value": "99.95%",
              "LocalName": "SLA"
            }
          ]
        },
        "UserVswitchId": "vsw-t4***eh****d7q****i2f",
        "AclName": "test",
        "AclType": "white",
        "AclStatus": "on",
        "AclId": "acl-uf6f9zfxfxtp5j9ng3yv4",
        "IntranetSegments": "[\\\"172.36.0.0/16\\\",\\\"172.31.16.0/20\\\"]",
        "IPV6AclName": "testIPV6",
        "IPV6AclId": "acl-124resFfs235",
        "IPV6AclType": "black",
        "IPV6AclStatus": "on",
        "DedicatedInstanceType": "vpc_connect",
        "InstanceCidrBlock": "192.168.0.0/16",
        "ConnectVpcId": "vpc-m5eo7khlb4h4f8y9egsdg",
        "NetworkInterfaceAttributes": {
          "NetworkInterfaceAttribute": [
            {
              "VswitchId": "vsw-2zeqals6rbj51bhjn8b89",
              "SecurityGroupId": "sg-2zeehz13zcyj1kfk3o85",
              "CidrBlock": "192.168.17.0/24",
              "ZoneId": "cn-shenzhen-d"
            }
          ]
        },
        "InstanceClusterId": "apigateway-cluster-sh-1523cafbgffd",
        "MaintainStartTime": "22:00Z",
        "MaintainEndTime": "01:00Z",
        "ConnectCidrBlocks": "[\\\"172.16.0.0/24\\\",\\\"172.16.1.0/24\\\"]",
        "PrivateDnsList": {
          "PrivateDns": [
            "www.private.com"
          ]
        },
        "Tags": {
          "TagInfo": [
            {
              "Key": "Cookie",
              "Value": "240"
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.