Obtaining the List of Gateway Groups

Description

This API is used to obtain the list of gateway groups.

URL

• URI format

  GET /v1/{project_id}/service/apigw/instances/{apig_instance_id}/groups [?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_instance_id	Yes	String	Gateway instance ID. For DLM Shared, the value of this parameter is APIG.
  apig_type	Yes	String	Gateway type. Available values include: APIG: API Gateway Shared edition APIGW: API Gateway Dedicated edition ROMA_APIC: ROMA-APIC gateway

Request Message

• Example request

  None

Response

• Example response

  {
    "gateway_groups": [
      {
        "group_id": "ef5a4d1dd3064702a943c2de303348e2",
        "group_name": "DEFAULT"
      }
    ]
  }

• Response parameter description

  Parameter	Type	Description
  gateway_groups	Dictionary	List of gateway groups

  • gateway_groups parameters

    Parameter	Type	Description
    group_id	String	Gateway group ID
    group_name	String	Gateway group name

Status Code

For details about status codes, see Status Codes.