Method update
Updates the specified API gateway.
HTTP request
PATCH https://serverless-apigateway.api.cloud.yandex.net/apigateways/v1/apigateways/{apiGatewayId}
Path parameters
| Parameter | Description |
|---|---|
| apiGatewayId | Required. ID of the API gateway to update. To get a API gateway ID make a list request. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "object",
"connectivity": {
"networkId": "string",
"subnetId": [
"string"
]
},
"openapiSpec": "string"
}
| Field | Description |
|---|---|
| updateMask | string Field mask that specifies which attributes of the API gateway should be updated. |
| name | string New name for the API gateway. The name must be unique within the folder. Value must match the regular expression |
| description | string New description for the API gateway. The maximum string length in characters is 256. |
| labels | object API gateway labels as 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 get request. No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression |
| connectivity | object Gateway connectivity. If specified the gateway will be attached to specified network/subnet(s). |
| 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. |
| openapiSpec | string The text of specification, JSON or YAML. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
| 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. |
| 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. |
| done | boolean (boolean) If the value is |
| 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 | object The error result of the operation in case of failure or cancellation. includes only one of the fields error, response |
| error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
| error. message |
string An error message. |
| error. details[] |
object A list of messages that carry the error details. |
| response | object includes only one of the fields error, responseThe 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. |