All Products
Search
Document Center

Function Compute:GetProvisionConfig

Last Updated:Sep 23, 2024

Queries the details of provisioned configurations.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
fc:GetProvisionConfigget
  • All Resources
    *
    none
none

Request syntax

GET /2021-04-06/services/{serviceName}/functions/{functionName}/provision-config HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
serviceNamestringYes

The service name.

demoService
qualifierstringYes

The name of the alias.

prod
functionNamestringYes

The function name.

demoFunction
X-Fc-Account-IdstringNo

The ID of your Alibaba Cloud account.

188077086902****
X-Fc-DatestringNo

The time when the function is invoked. The value is in the EEE,d MMM yyyy HH:mm:ss GMT format.

Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-IdstringNo

The trace ID of the request for Function Compute API.

rid281s******

Response parameters

ParameterTypeDescriptionExample
headersobject
ETagstring

The ETag of the provisioned configuration. The value is used to ensure that the modified configuration is consistent with the configuration that is expected to be modified.

object

The provisioned instance configuration of the function.

resourcestring

The resource description.

12345#servierName#qualifier#functionName
targetlong

The expected number of resources.

5
currentlong

The number of current resources.

1
scheduledActionsarray

The configurations of scheduled auto scaling.

scheduledActionScheduledActions

Details about the scheduled scaling policy. You can use the scheduled scaling policy to flexibly configure provisioned instances. You can specify the number of provisioned instances to the desired value at the scheduled time. This way, the number of provisioned instances can meet the concurrency requirements of your business.

[ { "Name":"action_1", "StartTime":"2020-11-01T10:00:00Z", "EndTime":"2020-11-30T10:00:00Z", "TargetValue":50, "ScheduleExpression":"cron(0 0 20 * * *)" }, { "Name":"action_2", "StartTime":"2020-11-01T10:00:00Z", "EndTime":"2020-11-30T10:00:00Z", "TargetValue":10, "ScheduleExpression":"cron(0 0 22 * * *)" } ]
targetTrackingPoliciesarray

The configurations of metric-based auto scaling.

targetTrackingPolicyTargetTrackingPolicies

Details about the metric-based scaling policy. Provisioned instances are scaled every minute based on the concurrency usage rate of provisioned instances.

  • When the metric value exceeds the value of metricTarget, the system starts to scale out provisioned instances with an active policy to restore the metric value close to the value of metricTarget.
  • When the metric value is lower than the value metricTarget, the system starts to scale in provisioned instances with a conservative policy so that the metric value gradually reaches the value metricTarget.

After you specify the maximum and minimum numbers of provisioned instances, the system scales in or out provisioned instances within the range from the minimum number to the maximum number. If the number of provisioned instances reaches the specified maximum or minimum number, scaling stops.

[ { "Name": "action_1", "StartTime": "2020-11-01T10:00:00Z", "EndTime": "2020-11-30T10:00:00Z", "MetricType": "ProvisionedConcurrencyUtilization", "MetricTarget": 0.6, "MinCapacity": 10, "MaxCapacity": 100 } ]
currentErrorstring

The error message returned if a provisioned instance fails to be created.

image not found
alwaysAllocateCPUboolean

Specifies whether to always allocate CPU resources to function instances.

true

Examples

Sample success responses

JSONformat

{
  "resource": "12345#servierName#qualifier#functionName",
  "target": 5,
  "current": 1,
  "scheduledActions": [
    {
      "name": "name",
      "startTime": "2020-10-10T10:10:10Z",
      "endTime": "2021-10-10T10:10:10Z",
      "target": 50,
      "scheduleExpression": "cron(0/30 * * * *)"
    }
  ],
  "targetTrackingPolicies": [
    {
      "name": "test_1",
      "startTime": "2020-10-10T10:10:10Z",
      "endTime": "2020-10-10T10:10:10Z",
      "metricType": "CPUUtilization",
      "metricTarget": 0.6,
      "minCapacity": 10,
      "maxCapacity": 100
    }
  ],
  "currentError": "image not found",
  "alwaysAllocateCPU": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2021-06-30The request parameters of the API has changedView Change Details
2021-06-30The request parameters of the API has changed. The response structure of the API has changedView Change Details
2021-06-30The request parameters of the API has changedView Change Details