API Gateway Service, REST: ApiGateway.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 Default value: 100. |
pageToken | Page token. To get the next page of results, set |
filter | A filter expression that filters functions listed in the response. The expression must specify:
|
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"
]
},
"logOptions": {
"disabled": true,
"minLevel": "string",
// `apiGateways[].logOptions` includes only one of the fields `logGroupId`, `folderId`
"logGroupId": "string",
"folderId": "string",
// end of the list of possible fields`apiGateways[].logOptions`
},
"variables": "object",
"canary": {
"weight": "string",
"variables": "object"
},
"executionTimeout": "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. 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). |
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 |
apiGateways[]. status |
string Status of the API gateway.
|
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. |
apiGateways[]. logOptions |
object Options for logging from the API gateway. |
apiGateways[]. logOptions. disabled |
boolean (boolean) Is logging from API gateway disabled. |
apiGateways[]. logOptions. minLevel |
string Minimum log entry level. See [LogLevel.Level] for details.
|
apiGateways[]. logOptions. logGroupId |
string apiGateways[].logOptions includes only one of the fields logGroupId , folderId Entry should be written to log group resolved by ID. |
apiGateways[]. logOptions. folderId |
string apiGateways[].logOptions includes only one of the fields logGroupId , folderId Entry should be written to default log group for specified folder. |
apiGateways[]. variables |
object Values of variables defined in the specification. |
apiGateways[]. canary |
object Canary release of the gateway. |
apiGateways[]. canary. weight |
string (int64) It describes percentage of requests, which will be processed by canary. Acceptable values are 0 to 99, inclusive. |
apiGateways[]. canary. variables |
object Required. Values specification variables, associated with canary. At least one per resource. |
apiGateways[]. executionTimeout |
string Timeout for gateway call execution The maximum value is 600 seconds. |
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |