All Products
Search
Document Center

Function Compute:ListProvisionConfigs

Last Updated:Nov 06, 2024

Queries configurations of provisioned instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:ListProvisionConfigsget
  • All Resources
    *
    none
none

Request syntax

GET /2021-04-06/provision-configs HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
limitlongNo

The maximum number of results to return. Default value: 20. Maximum value: 100. The number of returned resources is less than or equal to the specified number.

20
nextTokenstringNo

The token required to obtain more results. You do not need to specify this parameter in the first call. If a NextToken value is returned by a previous call, more results are available.

demoNextToken
serviceNamestringNo

The name of the service to which resources belong.

serviceName
qualifierstringNo

The qualifier of the service to which resources belong. The qualifier must be aliasName and used together with the serviceName parameter.

prod
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
object

The list of provisioned instance configurations.

nextTokenstring

The token used to obtain more results.

demoNextToken
provisionConfigsarray<object>

The provisioned instance configurations.

provisionConfigobject

The provisioned configuration details.

resourcestring

The description of the resource.

12345#servierName#qualifier#functionName
targetlong

The expected number of resources.

5
currentlong

The number of current resources.

5
scheduledActionsarray

The configurations of scheduled auto scaling.

scheduledActionScheduledActions

The details about the scheduled scaling policy. You can use the scheduled scaling policy to flexibly configure provisioned instances. You can set the number of provisioned instances to a 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 metric-based scaling policy.

targetTrackingPolicyTargetTrackingPolicies

The 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.

If you specify the maximum and minimum numbers of provisioned instances, the system scales provisioned instances within the range. 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

{
  "nextToken": "demoNextToken",
  "provisionConfigs": [
    {
      "resource": "12345#servierName#qualifier#functionName",
      "target": 5,
      "current": 5,
      "scheduledActions": [
        {
          "name": "",
          "startTime": "",
          "endTime": "",
          "target": 0,
          "scheduleExpression": ""
        }
      ],
      "targetTrackingPolicies": [
        {
          "name": "",
          "startTime": "",
          "endTime": "",
          "metricType": "",
          "metricTarget": 0,
          "minCapacity": 0,
          "maxCapacity": 0
        }
      ],
      "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