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`
},
"variables": "object",
"canary": {
"weight": "string",
"variables": "object"
},
"executionTimeout": "string"
}
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 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 |
status | string 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[] | 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.
|
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. |
variables | object Values of variables defined in the specification. |
canary | object Canary release of the gateway. |
canary. weight |
string (int64) It describes percentage of requests, which will be processed by canary. Acceptable values are 0 to 99, inclusive. |
canary. variables |
object Required. Values specification variables, associated with canary. At least one per resource. |
executionTimeout | string Timeout for gateway call execution The maximum value is 600 seconds. |
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. |