Help Center> API Gateway> API Reference> Dedicated Gateway APIs (V2)> Gateway Management> Querying Dedicated Gateways
View PDF

Querying Dedicated Gateways

Function

This API is used to query dedicated gateways.

Debugging

You can use API Explorer to debug this API.

URI

GET /v2/{project_id}/apigw/instances

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see "Appendix" > "Obtaining a Project ID" in this document.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.

Default: 0

limit

No

Integer

Number of records displayed on each page.

Minimum: 1

Maximum: 500

Default: 20

instance_id

No

String

Gateway ID.

instance_name

No

String

Gateway name.

status

No

String

Gateway status.

  • Creating

  • CreateSuccess

  • CreateFail

  • Initing

  • Registering

  • Running

  • InitingFailed

  • RegisterFailed

  • Installing

  • InstallFailed

  • Updating

  • UpdateFailed

  • Rollbacking

  • RollbackSuccess

  • RollbackFailed

  • Deleting

  • DeleteFailed

  • Unregistering

  • UnRegisterFailed

  • CreateTimeout

  • InitTimeout

  • RegisterTimeout

  • InstallTimeout

  • UpdateTimeout

  • RollbackTimeout

  • DeleteTimeout

  • UnregisterTimeout

  • Starting

  • Freezing

  • Frozen

  • Restarting

  • RestartFail

  • Unhealthy

  • RestartTimeout

Enumeration values:

  • Creating

  • CreateSuccess

  • CreateFail

  • Initing

  • Registering

  • Running

  • InitingFailed

  • RegisterFailed

  • Installing

  • InstallFailed

  • Updating

  • UpdateFailed

  • Rollbacking

  • RollbackSuccess

  • RollbackFailed

  • Deleting

  • DeleteFailed

  • Unregistering

  • UnRegisterFailed

  • CreateTimeout

  • InitTimeout

  • RegisterTimeout

  • InstallTimeout

  • UpdateTimeout

  • RollbackTimeout

  • DeleteTimeout

  • UnregisterTimeout

  • Starting

  • Freezing

  • Frozen

  • Restarting

  • RestartFail

  • Unhealthy

  • RestartTimeout

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

instances

Array of RespInstanceBase objects

Gateway list.
Table 5 RespInstanceBase

Parameter

Type

Description

id

String

Gateway ID.

project_id

String

ID of the tenant to which the gateway belongs.

instance_name

String

Gateway name.

status

String

Gateway status.

  • Creating: The gateway is being created.

  • CreateSuccess: The gateway is created successfully.

  • CreateFail: The gateway fails to be created.

  • Initing: The gateway is being initialized.

  • Registering: The gateway is being registered.

  • Running: The gateway is running.

  • InitingFailed: The gateway fails to be initialized.

  • RegisterFailed: The gateway fails to be registered.

  • Installing: The gateway is being installed.

  • InstallFailed: The gateway fails to be installed.

  • Updating: The gateway is being upgraded.

  • UpdateFailed: The gateway fails to be upgraded.

  • Rollbacking: The gateway is being rolled back.

  • RollbackSuccess: The gateway is rolled back successfully.

  • RollbackFailed: The gateway fails to be rolled back.

  • Deleting: The gateway is being deleted.

  • DeleteFailed: The gateway fails to be deleted.

  • Unregistering: The gateway is being deregistered.

  • UnRegisterFailed: The gateway fails to be deregistered.

  • CreateTimeout: Creation of the gateway times out.

  • InitTimeout: Initialization of the gateway times out.

  • RegisterTimeout: Registration of the gateway times out.

  • InstallTimeout: Installation of the gateway times out.

  • UpdateTimeout: Upgrading of the gateway times out.

  • RollbackTimeout: Rollback of the gateway times out.

  • DeleteTimeout: Deletion of the gateway times out.

  • UnregisterTimeout: Deregistration of the gateway times out.

  • Starting: The gateway is being started.

  • Freezing: The gateway is being frozen.

  • Frozen: The gateway is frozen.

  • Restarting: The gateway is being restarted.

  • RestartFail: The gateway fails to be restarted.

  • Unhealthy: The gateway is abnormal.

  • RestartTimeout: Restart of the gateway times out.

Enumeration values:

  • Creating

  • CreateSuccess

  • CreateFail

  • Initing

  • Registering

  • Running

  • InitingFailed

  • RegisterFailed

  • Installing

  • InstallFailed

  • Updating

  • UpdateFailed

  • Rollbacking

  • RollbackSuccess

  • RollbackFailed

  • Deleting

  • DeleteFailed

  • Unregistering

  • UnRegisterFailed

  • CreateTimeout

  • InitTimeout

  • RegisterTimeout

  • InstallTimeout

  • UpdateTimeout

  • RollbackTimeout

  • DeleteTimeout

  • UnregisterTimeout

  • Starting

  • Freezing

  • Frozen

  • Restarting

  • RestartFail

  • Unhealthy

  • RestartTimeout

instance_status

Integer

Gateway status ID.

  • 1: Creating

  • 2: Created

  • 3: Creation failed

  • 4: Initializing

  • 5: Registering

  • 6: Running

  • 7: Initialization failed

  • 8: Registration failed

  • 10: Installing

  • 11: Installation failed

  • 12: Upgrading

  • 13: Upgrade failed

  • 20: Rolling back

  • 21: Rolled back

  • 22: Rollback failed

  • 23: Deleting

  • 24: Deletion failed

  • 25: Deregistering

  • 26: Deregistration failed

  • 27: Creation timeout

  • 28: Initialization timeout

  • 29: Registration timeout

  • 30: Installation timeout

  • 31: Upgrade timeout

  • 32: Rollback timeout

  • 33: Deletion timeout

  • 34: Deregistration timeout

  • 35: Starting

  • 36: Freezing

  • 37: Frozen

  • 38: Restarting

  • 39: Restarting failed

  • 40: Abnormal

  • 41: Restarting timeout

Enumeration values:

  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 10

  • 11

  • 12

  • 13

  • 20

  • 21

  • 22

  • 23

  • 24

  • 25

  • 26

  • 27

  • 28

  • 29

  • 30

  • 31

  • 32

  • 33

  • 34

  • 35

  • 36

  • 37

  • 38

  • 39

  • 40

  • 41

type

String

Gateway type.

The default value is apig.

spec

String

Gateway edition.

  • BASIC

  • PROFESSIONAL

  • ENTERPRISE

  • PLATINUM

  • BASIC_IPV6

  • PROFESSIONAL_IPV6

  • ENTERPRISE_IPV6

  • PLATINUM_IPV6

Enumeration values:

  • BASIC

  • PROFESSIONAL

  • ENTERPRISE

  • PLATINUM

  • BASIC_IPV6

  • PROFESSIONAL_IPV6

  • ENTERPRISE_IPV6

  • PLATINUM_IPV6

create_time

Long

Time when the gateway is created. The time is in the Unix timestamp format.

enterprise_project_id

String

Enterprise project ID. This parameter is required if you are using an enterprise account.

eip_address

String

EIP bound to the gateway.

charging_mode

Integer

Billing mode of the gateway.

  • 0: Pay per use

  • 1: Yearly/Monthly

Enumeration values:

  • 0

  • 1

cbc_metadata

String

Yearly/Monthly subscription order ID.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "total" : 2,
  "size" : 2,
  "instances" : [ {
    "cbc_metadata" : "CS2006301043A28NF:00301-734023-0--0",
    "charging_mode" : 1,
    "create_time" : 1585302825070,
    "eip_address" : "100.95.155.221",
    "enterprise_project_id" : "0",
    "id" : "eddc4d25480b4cd6b512f270a1b8b341",
    "instance_name" : "apig-Enterprise_Project_Pay-per-Use",
    "instance_status" : 6,
    "project_id" : "73d69ae0cfcf460190522d06b60f05ad",
    "spec" : "PROFESSIONAL",
    "status" : "Running",
    "type" : "apig"
  }, {
    "charging_mode" : 0,
    "create_time" : 1594370987422,
    "eip_address" : "100.95.147.95",
    "enterprise_project_id" : "0",
    "id" : "2e2d613c64094a4a94ad38e7ca30adee",
    "instance_name" : "apig-autotest-apitest-nodelete",
    "instance_status" : 6,
    "project_id" : "73d69ae0cfcf460190522d06b60f05ad",
    "spec" : "PROFESSIONAL",
    "status" : "Running",
    "type" : "apig"
  } ]
}

Status code: 401

Unauthorized

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIC.9000",
  "error_msg" : "Failed to request internal service"
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Gateway Management