API Gateway Service, REST: ApiGateway.Update

Field

Description

apiGatewayId

string

Required field. ID of the API gateway to update.
To get a API gateway ID make a ApiGatewayService.List request.

Field

Description

updateMask

string (field-mask)

A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

name

string

New name for the API gateway.
The name must be unique within the folder.

Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.

description

string

New description for the API gateway.

The maximum string length in characters is 256.

labels

object (map<string, string>)

API gateway labels as key:value pairs.
Existing set of labels is completely replaced by the provided set, so if you just want
to add or remove a label, request the current set of labels with a yandex.cloud.serverless.apigateway.v1.ApiGatewayService.Get request.

The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\@0-9a-z]*. Each value must match the regular expression [-_./\@0-9a-z]*. No more than 64 per resource.

openapiSpec

string

The text of specification, JSON or YAML.

Includes only one of the fields openapiSpec.

New OpenAPI specification of API gateway.

connectivity

Connectivity

Gateway connectivity. If specified the gateway will be attached to specified network/subnet(s).

logOptions

LogOptions

Options for logging from the API gateway.

variables

object (map<string, VariableInput>)

Values of variables defined in the specification.

canary

Canary

Canary release of the gateway.

executionTimeout

string (duration)

Timeout for gateway call execution

Field

Description

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.

Field

Description

disabled

boolean

Is logging from API gateway disabled.

logGroupId

string

Entry should be written to log group resolved by ID.

Includes only one of the fields logGroupId, folderId.

Log entries destination.

folderId

string

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

Includes only one of the fields logGroupId, folderId.

Log entries destination.

minLevel

enum (Level)

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.

Field

Description

stringValue

string

Includes only one of the fields stringValue, intValue, doubleValue, boolValue.

Variable value that can has only primitive type

intValue

string (int64)

Includes only one of the fields stringValue, intValue, doubleValue, boolValue.

Variable value that can has only primitive type

doubleValue

string

Includes only one of the fields stringValue, intValue, doubleValue, boolValue.

Variable value that can has only primitive type

boolValue

boolean

Includes only one of the fields stringValue, intValue, doubleValue, boolValue.

Variable value that can has only primitive type

Field

Description

weight

string (int64)

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

Acceptable values are 0 to 99, inclusive.

variables

object (map<string, VariableInput>)

Values specification variables, associated with canary.

More than 0 per resource.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

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

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

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

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

object

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

object

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.