Referensi API ListGateway - Microservices Engine - Alibaba Cloud - Microservices Engine

Mengkueri daftar gerbang.

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

mse:ListGateway

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Nomor halaman.	1
PageSize	integer	No	Jumlah entri per halaman.	10
OrderItem	string	No	Kriteria Pengurutan.	{}
DescSort	boolean	No	Apakah akan mengurutkan hasil dalam Pesanan menurun. Parameter ini saat ini tidak digunakan.	false
FilterParams	object	No	Parameter filter.
GatewayType	string	No	The gateway type.	Ingress
Name	string	No	The gateway name.	rutain-test
Vpc	string	No	The VPC ID.	vpc-bp13hhyjntbab7w****
GatewayUniqueId	string	No	The unique gateway ID.	gw-5017305290e14centbrveca****
InstanceId	string	No	The instance ID.	mse_ingresspre-cn-****
MseTag	string	No	The resource tag.	[{"key":"tagkey","value":"tagvalue"}]
ResourceGroupId	string	No	The resource group ID.	rg-7y2uye*****
AcceptLanguage	string	No	Bahasa tanggapan. Nilai valid: zh: Tionghoa en: Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object	The data structure.
RequestId	string	The request ID.	34300B3-52EC-5049-8C96-914098CF****
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*
Code	integer	The response code.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The response data.
TotalSize	integer	The total number of entries.	9
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
Result	array<object>	The list of gateways.
	array<object>	The details of a gateway.
Id	integer	The gateway ID.	153
Name	string	The gateway name.	tesa-test
GatewayUniqueId	string	The unique ID of the gateway.	gw-5017305290e14cebb8ce5cb6a4****
GatewayType	string	The gateway type.	Ingress
Region	string	The region of the gateway.	cn-hangzhou
PrimaryUser	string	The information about the Alibaba Cloud account.	18278117654342
Status	integer	The gateway state. Valid values: 0: The gateway is being created. 1: The gateway failed to be created. 2: The gateway is running. 3: The gateway is changing. 4: The gateway is scaling in. 6: The gateway is scaling out. 8: The gateway is being deleted. 9: The gateway is suspended and to be released. 10: The gateway is restarting. 11: The gateway is being rebuilt. 12: The gateway is being upgraded. 13: The gateway failed to be upgraded.	2
AhasOn	boolean	Indicates whether AHAS is enabled.	false
ArmsOn	boolean	Indicates whether ARMS is enabled.	false
Spec	string	The specifications.	MSE_GTW_1_2_200_c
Replica	integer	The backup.	2
GmtCreate	string	The time when the gateway was created.	2021-09-13 19:24:23
GmtModified	string	The time when the gateway was modified.	2021-09-13 19:24:23
StatusDesc	string	The status description.	重启中
Slb	array<object>	The SLB collection.
	object	The SLB collection information.
SlbIp	string	The IP address of the SLB instance.	153.12.XX.XX
SlbPort	string	The SLB port.	80
SlbSpec	string	The SLB specifications.	slb.s2.small
Type	string	The network type. Valid values: PUB_NET: Internet PRIVATE_NET: VPC	PUB_NET
GatewaySlbStatus	string	The gateway SLB status.	Ready
StatusDesc	string	The status description.	创建中
GatewaySlbMode	string	The gateway SLB mode.	UserHost
SlbId	string	The ID of the SLB instance.	lb-bp1ut8asdfgucjk****
InternetSlb	array<object>	The Internet SLB.
	object	The data structure.
SlbIp	string	The IP address of the SLB instance.	153.12.XX.XX
SlbPort	string	The SLB port.	slb.s2.small
SlbSpec	string	The SLB specifications.	slb.s2.small
Type	string	The type.	PUB_NET
InternetNetworkFlow	string	The traffic of the gateway.	20
GatewaySlbStatus	string	The gateway SLB status.	Ready
StatusDesc	string	The status description.	创建中
GatewaySlbMode	string	The gateway SLB mode.	UserHost
SlbId	string	The ID of the SLB instance.	lb-bp1ut8asdfgucjk****
Upgrade	boolean	The upgrade.	false
MustUpgrade	boolean	The forced upgrade.	false
SupportWasm	boolean	Indicates whether WASM is supported.	true
CurrentVersion	string	The current version of the gateway.	0.1.0-mse-gw
AppVersion	string	The application version.	1.0.1.0
LatestVersion	string	The latest version.	0.1.0-mse-gw
Vswitch2	string	The vSwitch 2.	vsw-bpbrveck45nf****
InstanceId	string	The instance ID.	mse_ingresspost-cn-0jbvrcex****
ChargeType	string	The billing method.	POSTPAY
EndDate	string	The time when the subscription gateway expires.	4792060800000
Tag	string	The tag.	test
InitConfig	object	The configurations.
EnableWaf	boolean	Indicates whether WAF is enabled.	true
SupportWaf	boolean	Indicates whether WAF is supported.	true
GatewayVersion	string	The gateway version.	1.2.9
RollBack	boolean	Indicates whether rollbacks are allowed.	false
MseTag	string	The resource tag.	{"tagKey":"tagValue"}
ResourceGroupId	string	The resource group ID.	rg-97hg87vi****
TotalReplica	integer	The total number of replicas, including the number of replicas that are automatically scaled out.	4
Elastic	boolean	Indicates whether auto scale-out is enabled.	true
ElasticReplica	integer	The number of replicas that are automatically scaled out.	2
ElasticType	string	The type of auto scale-out. Valid value: CronHPA: scale-out by time	CronHPA
ElasticPolicy	object	The auto scale-out policy.
Elastic	boolean	Indicates whether auto scale-out is enabled.	true
MaxReplica	integer	The maximum number of instances that are automatically scaled out. This parameter is used for horizontal scale-out.	10
ElasticType	string	The type of auto scale-out. Valid value: CronHPA: scale-out by time	CronHPA
TimePolicyList	array<object>	The time policy list for auto scale-out.
	object
DesiredReplica	integer	The expected number of replicas for auto scale-out.	4
StartTime	string	The start time of auto scale-out.	07:00
EndTime	string	The end time of auto scale-out.	09:00
LoadWarningThreshold	boolean	The type of the threshold for load-based scaling. The value true indicates that the warning threshold is used. The value false indicates that the security threshold is used.
EnableScaleTimePolicyList	array<object>	The time period during which scale-in is allowed.
	object
StartTime	string
EndTime	string
ElasticInstanceId	string	The gateway elastic instance ID, which is returned when auto scale-out is used.	mse_ingresselastic_public_cn-uqm3d0*****
VpcId	string	The gateway VPC ID.	vpc-uf6heojei217tv14*****
MseVersion	string
MaintenancePeriod	object
TimeZone	string
StartTime	string
EndTime	string
GatewayEntry	array<object>	The ingress address of the gateway that uses the Professional Edition of common instances.
	object
NetType	string	The ingress network type. Valid values: PRIVATE_NET: VPC PUB_NET: Internet	PUB_NET
EntryDomain	string	The ingress domain name.	gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com
IpList	array	The ingress IP addresses.
	string	The ingress IP address.	1.2.3.4
HttpPorts	array	The HTTP listener ports.
	integer	The HTTP listener port.	80
HttpsPorts	array	The HTTPS listener ports.
	integer	The HTTPS listener port.	443
VersionLifecycle	string

Contoh

Respons sukses

JSONformat

{
  "RequestId": "34300B3-52EC-5049-8C96-914098CF****",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*",
  "Code": 200,
  "Success": true,
  "Data": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 153,
        "Name": "tesa-test",
        "GatewayUniqueId": "gw-5017305290e14cebb8ce5cb6a4****",
        "GatewayType": "Ingress",
        "Region": "cn-hangzhou",
        "PrimaryUser": "18278117654342",
        "Status": 2,
        "AhasOn": false,
        "ArmsOn": false,
        "Spec": "MSE_GTW_1_2_200_c",
        "Replica": 2,
        "GmtCreate": "2021-09-13 19:24:23",
        "GmtModified": "2021-09-13 19:24:23",
        "StatusDesc": "重启中",
        "Slb": [
          {
            "SlbIp": "153.12.XX.XX",
            "SlbPort": "80",
            "SlbSpec": "slb.s2.small",
            "Type": "PUB_NET",
            "GatewaySlbStatus": "Ready",
            "StatusDesc": "创建中",
            "GatewaySlbMode": "UserHost",
            "SlbId": "lb-bp1ut8asdfgucjk****"
          }
        ],
        "InternetSlb": [
          {
            "SlbIp": "153.12.XX.XX",
            "SlbPort": "slb.s2.small",
            "SlbSpec": "slb.s2.small",
            "Type": "PUB_NET",
            "InternetNetworkFlow": "20",
            "GatewaySlbStatus": "Ready",
            "StatusDesc": "创建中",
            "GatewaySlbMode": "UserHost",
            "SlbId": "lb-bp1ut8asdfgucjk****"
          }
        ],
        "Upgrade": false,
        "MustUpgrade": false,
        "SupportWasm": true,
        "CurrentVersion": "0.1.0-mse-gw",
        "AppVersion": "1.0.1.0",
        "LatestVersion": "0.1.0-mse-gw",
        "Vswitch2": "vsw-bpbrveck45nf****",
        "InstanceId": "mse_ingresspost-cn-0jbvrcex****",
        "ChargeType": "POSTPAY",
        "EndDate": "4792060800000",
        "Tag": "test",
        "InitConfig": {
          "EnableWaf": true,
          "SupportWaf": true
        },
        "GatewayVersion": "1.2.9",
        "RollBack": false,
        "MseTag": "{\"tagKey\":\"tagValue\"}",
        "ResourceGroupId": "rg-97hg87vi****",
        "TotalReplica": 4,
        "Elastic": true,
        "ElasticReplica": 2,
        "ElasticType": "CronHPA",
        "ElasticPolicy": {
          "Elastic": true,
          "MaxReplica": 10,
          "ElasticType": "CronHPA",
          "TimePolicyList": [
            {
              "DesiredReplica": 4,
              "StartTime": "07:00",
              "EndTime": "09:00"
            }
          ],
          "LoadWarningThreshold": false,
          "EnableScaleTimePolicyList": [
            {
              "StartTime": "",
              "EndTime": ""
            }
          ]
        },
        "ElasticInstanceId": "mse_ingresselastic_public_cn-uqm3d0*****",
        "VpcId": "vpc-uf6heojei217tv14*****",
        "MseVersion": "",
        "MaintenancePeriod": {
          "TimeZone": "",
          "StartTime": "",
          "EndTime": ""
        },
        "GatewayEntry": [
          {
            "NetType": "PUB_NET",
            "EntryDomain": "gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com",
            "IpList": [
              "1.2.3.4"
            ],
            "HttpPorts": [
              80
            ],
            "HttpsPorts": [
              443
            ]
          }
        ],
        "VersionLifecycle": ""
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	IllegalRequest	Invalid request:%s
400	InvalidParameter	Parameter error:%s
500	InternalError	Console error. Try again later:%s
403	NoPermission	You are not authorized to perform this operation:%s
404	NotFound	Not found:%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.