Cloud Functions Service, REST: Function.SetScalingPolicy
Set scaling policy for specified function and tag
HTTP request
POST https://serverless-functions.api.cloud.yandex.net/functions/v1/functions/{functionId}:setScalingPolicy
Path parameters
Field |
Description |
functionId |
string Required field. ID of the function to retrieve scaling policies for. To get a function ID, make a FunctionService.List request. |
Body parameters
{
"tag": "string",
"provisionedInstancesCount": "string",
"zoneInstancesLimit": "string",
"zoneRequestsLimit": "string"
}
Field |
Description |
tag |
string Required field. Version tag. To get the history of version tags make a FunctionService.ListTagHistory request. |
provisionedInstancesCount |
string (int64) Minimum guaranteed provisioned instances count for all zones in total. |
zoneInstancesLimit |
string (int64) Upper limit for instance count in each zone. |
zoneRequestsLimit |
string (int64) Upper limit of requests count in each zone. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"functionId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"functionId": "string",
"tag": "string",
"createdAt": "string",
"modifiedAt": "string",
"provisionedInstancesCount": "string",
"zoneInstancesLimit": "string",
"zoneRequestsLimit": "string"
}
// 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 To work with values in this field, use the APIs described in the |
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 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
SetScalingPolicyMetadata
Field |
Description |
functionId |
string ID of the function for which scaling policy was set. |
Status
The error result of the operation in case of failure or cancellation.
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. |
ScalingPolicy
Field |
Description |
functionId |
string ID of the function that the scaling policy belongs to. |
tag |
string Tag of the version that the scaling policy belongs to. For details, see Version tag. |
createdAt |
string (date-time) Creation timestamp for the scaling policy String in RFC3339 To work with values in this field, use the APIs described in the |
modifiedAt |
string (date-time) Modification timestamp for the scaling policy String in RFC3339 To work with values in this field, use the APIs described in the |
provisionedInstancesCount |
string (int64) Minimum guaranteed provisioned instances count for all zones in total. |
zoneInstancesLimit |
string (int64) Upper limit for instance count in each zone. |
zoneRequestsLimit |
string (int64) Upper limit of requests count in each zone. |