Viewing operations with API Gateway resources
All actions with API Gateway resources are logged as a list of operations. Each operation gets its own unique ID.
Getting a list of operations
You can get a list of operations for a specific resource. The steps below describe how you can do this for an API gateway. The same steps apply to other API Gateway resources.
-
In the management console, open the folder containing the API gateway.
-
Select API Gateway.
-
In the left-hand panel, select API gateways.
-
Select the API gateway you need.
-
Go to the Operations panel for the selected API gateway.
You will see a list of operations with the selected API gateway.
If you do not have the Yandex Cloud (CLI) command line interface yet, install and initialize it.
The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.
To get a list of operations for an API Gateway resource, run this command:
yc serverless <resource_type> list-operations <resource_name_or_ID>
Example
Getting a list of operations for an API gateway:
yc serverless api-gateway list-operations epdplu8jn7sr********
Result:
+----------------------+---------------------+----------------------+---------------------+--------+------------------+
| ID | CREATED AT | CREATED BY | MODIFIED AT | STATUS | DESCRIPTION |
+----------------------+---------------------+----------------------+---------------------+--------+------------------+
| d5d6ja2j20tj******** | 2024-06-21 09:59:41 | aje9k8luj4qf******** | 2024-06-21 09:59:43 | DONE | operation_update |
| d5dphtf4p0tp******** | 2024-06-21 09:51:17 | aje9k8luj4qf******** | 2024-06-21 09:51:20 | DONE | operation_create |
+----------------------+---------------------+----------------------+---------------------+--------+------------------+
By default, information about operations is output as text. To get detailed information, specify the yaml or json output data format using the --format flag:
yc serverless api-gateway list-operations <API_gateway_name_or_ID> --format yaml
Result:
- id: d5d6ja2j20tj********
description: operation_update
created_at: "2024-06-21T09:59:41.804Z"
created_by: aje9k8luj4qf********
modified_at: "2024-06-21T09:59:43.519Z"
done: true
metadata:
'@type': type.googleapis.com/yandex.cloud.serverless.apigateway.v1.UpdateApiGatewayMetadata
api_gateway_id: d5dig9e60uco********
...
Use the listOperations REST API method for the relevant resource or the <service>/ListOperations gRPC API call.
For example, for an API gateway, use either the listOperations REST API method for the ApiGateway resource or the ApiGatewayService/ListOperations gRPC API call.
Getting detailed information about an operation
-
Get a list of operations for the API gateway.
-
Copy the operation ID.
-
Get detailed information about the operation:
CLIAPIIf you do not have the Yandex Cloud (CLI) command line interface yet, install and initialize it.
The folder specified when creating the CLI profile is used by default. To change the default folder, use the
yc config set folder-id <folder_ID>command. You can specify a different folder using the--folder-nameor--folder-idparameter.Run this command:
yc operation get <operation_ID>Result:
id: d5dphtf4p0tp******** description: operation_create created_at: "2024-06-21T09:51:17.430Z" created_by: aje9k8luj4qf******** modified_at: "2024-06-21T09:51:20.810Z" done: true metadata: '@type': type.googleapis.com/yandex.cloud.serverless.apigateway.v1.CreateApiGatewayMetadata api_gateway_id: d5dig9e60uco******** response: '@type': type.googleapis.com/yandex.cloud.serverless.apigateway.v1.ApiGateway id: d5dig9e60uco******** folder_id: b1g681qpemb4******** created_at: "2024-06-21T09:51:17.489Z" name: operation-logs status: ACTIVE domain: d5dm1lba80md********.i9******.apigw.yandexcloud.net connectivity: {} log_options: folder_id: b1g681qpemb4******** execution_timeout: 300sUse the OperationService/Get gRPC API call.