Подключиться
Yandex API Gateway

Method list

Статья создана

Retrieves the list of API gateways in the specified folder.

HTTP request

GET https://serverless-apigateway.api.cloud.yandex.net/apigateways/v1/apigateways

Query parameters

Parameter Description
folderId

Required. ID of the folder to list API gateways in.

To get a folder ID make a list request.
pageSize

The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

Default value: 100.
pageToken

Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request.
filter

A filter expression that filters functions listed in the response.

The expression must specify:

  1. The field name. Currently filtering can only be applied to the ApiGateway.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z]([-a-z0-9]{0,61}[a-z0-9])?. Example of a filter: name=my-apigw.

Response

HTTP Code: 200 - OK

{
  "apiGateways": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "status": "string",
      "domain": "string",
      "logGroupId": "string",
      "attachedDomains": [
        {
          "domainId": "string",
          "certificateId": "string",
          "enabled": true,
          "domain": "string"
        }
      ],
      "connectivity": {
        "networkId": "string",
        "subnetId": [
          "string"
        ]
      }
    }
  ],
  "nextPageToken": "string"
}
Field Description
apiGateways[] object

List of API gateways in the specified folder.
apiGateways[].
id		 string

ID of the API gateway. Generated at creation time.
apiGateways[].
folderId		 string

ID of the folder that the API gateway belongs to.
apiGateways[].
createdAt		 string (date-time)

Creation timestamp for the API-gateway.

String in RFC3339 text format.
apiGateways[].
name		 string

Name of the API gateway. The name is unique within the folder.
apiGateways[].
description		 string

Description of the API gateway.
apiGateways[].
labels		 object

API gateway labels as key:value pairs.
apiGateways[].
status		 string

Status of the API gateway.

  • CREATING: API gateway is being created.
  • ACTIVE: API gateway is ready for use.
  • DELETING: API gateway is being deleted.
  • ERROR: API gateway failed. The only allowed action is delete.
  • UPDATING: API gateway is being updated.
apiGateways[].
domain		 string

Default domain for the API gateway. Generated at creation time.
apiGateways[].
logGroupId		 string

ID of the log group for the API gateway.
apiGateways[].
attachedDomains[]		 object

List of domains attached to API gateway.
apiGateways[].
attachedDomains[].
domainId		 string

ID of the domain.
apiGateways[].
attachedDomains[].
certificateId		 string

ID of the domain certificate.
apiGateways[].
attachedDomains[].
enabled		 boolean (boolean)

Enabling flag.
apiGateways[].
attachedDomains[].
domain		 string

Name of the domain.
apiGateways[].
connectivity		 object

Network access. If specified the gateway will be attached to specified network/subnet(s).

Gateway connectivity specification.
apiGateways[].
connectivity.
networkId		 string

Network the gateway will have access to. It's essential to specify network with subnets in all availability zones.
apiGateways[].
connectivity.
subnetId[]		 string

Complete list of subnets (from the same network) the gateway can be attached to. It's essential to specify at least one subnet for each availability zones.
nextPageToken string

Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use nextPageToken as the value for the pageToken parameter in the next list request.

Each subsequent page will have its own nextPageToken to continue paging through the results.
В этой статье: