Obtaining the List of Gateway Instances

Description

This API is used to obtain the list of gateway instances of a specified type.

URL

• URI format

  GET /v1/{project_id}/service/apigw/instances [?apig_type]

• Parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.
  apig_type	Yes	String	Gateway type. Available values include: APIGW: API Gateway Dedicated edition ROMA_APIC: ROMA-APIC gateway

Request Message

• Example request

  None

Response

• Example response

  {
    "gateway_instances": [
      {
        "instance_id": "0ca3311f5dc941b7b3d1950d1682b646",
        "instance_name": "apigw_test_001"
      }
    ]
  }

• Response parameter description

  Parameter	Type	Description
  gateway_instances	Dictionary	List of gateway instances

  • gateway_instances parameters

    Parameter	Type	Description
    instance_id	String	Gateway instance ID
    instance_name	String	Gateway instance name

Status Code

For details about status codes, see Status Codes.