Skip to main content

types

ApiGateway​

Status​

  • STATUS_UNSPECIFIED

  • 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.

id : string​

ID of the API gateway. Generated at creation time.

folderId : string​

ID of the folder that the API gateway belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp for the API-gateway.

name : string​

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

description : string​

Description of the API gateway.

labels : string​

API gateway labels as key:value pairs.

status : Status​

Status of the API gateway.

domain : string​

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

logGroupId : string​

ID of the log group for the API gateway.

attachedDomains : AttachedDomain​

List of domains attached to API gateway.

connectivity : Connectivity​

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

logOptions : LogOptions​

Options for logging from the API gateway.

variables : VariableInput​

Values of variables defined in the specification.

canary : Canary​

Canary release of the gateway.

executionTimeout : google.protobuf.Duration​

Timeout for gateway call execution

AttachedDomain​

domainId : string​

ID of the domain.

certificateId : string​

ID of the domain certificate.

enabled : bool​

Enabling flag.

domain : string​

Name of the domain.

Canary​

weight : int64​

It describes percentage of requests, which will be processed by canary.

variables : VariableInput​

Values specification variables, associated with canary.

Connectivity​

Gateway connectivity specification.

networkId : string​

Network the gateway will have access to. It's essential to specify network with subnets in all availability zones.

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​

disabled : bool​

Is logging from API gateway disabled.

One of destination​

Log entries destination.

  • logGroupId : string​

    Entry should be written to log group resolved by ID.

  • folderId : string​

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

minLevel : yandex.cloud.logging.v1.LogLevel.Level​

Minimum log entry level.

See LogLevel.Level for details.

VariableInput​

One of variableValue​

Variable value that can has only primitive type

  • stringValue : string​
  • intValue : int64​
  • doubleValue : double​
  • boolValue : bool​