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

API Gateway Service, REST: ApiGateway methods

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

A set of methods for managing API gateways.

JSON Representation

{
  "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"
    ]
  },
  "logOptions": {
    "disabled": true,
    "minLevel": "string",

    // `logOptions` includes only one of the fields `logGroupId`, `folderId`
    "logGroupId": "string",
    "folderId": "string",
    // end of the list of possible fields`logOptions`

  }
}
Field Description
id string

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

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

Creation timestamp for the API-gateway.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
name string

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

Description of the API gateway.
labels object

API gateway labels as key:value pairs.
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.
domain string

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

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

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

ID of the domain.
attachedDomains[].
certificateId		 string

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

Enabling flag.
attachedDomains[].
domain		 string

Name of the domain.
connectivity object

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

Gateway connectivity specification.
connectivity.
networkId		 string

Network the gateway will have access to. It's essential to specify network with subnets in all availability zones.
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.
logOptions object

Options for logging from the API gateway.
logOptions.
disabled		 boolean (boolean)

Is logging from API gateway disabled.
logOptions.
minLevel		 string
Minimum log entry level. See [LogLevel.Level] for details.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.
logOptions.
logGroupId		 string
logOptions includes only one of the fields logGroupId, folderId

Entry should be written to log group resolved by ID.
logOptions.
folderId		 string
logOptions includes only one of the fields logGroupId, folderId

Entry should be written to default log group for specified folder.

Methods

Method Description
addDomain Attaches domain to the specified API gateway.
create Creates an API gateway in the specified folder.
delete Deletes the specified API gateway.
get Returns the specified API gateway. Note that only API gateway basic attributes are returned. To get associated openapi specification, make a GetOpenapiSpec request.
getOpenapiSpec Returns the OpenAPI specification of specified API gateway.
list Retrieves the list of API gateways in the specified folder.
listAccessBindings Lists existing access bindings for the specified API gateway.
listOperations Lists operations for the specified API gateway.
removeDomain Detaches domain from the specified API gateway.
setAccessBindings Sets access bindings for the specified API gateway.
update Updates the specified API gateway.
updateAccessBindings Updates access bindings for the specified API gateway.
В этой статье: