Query provisioned instance configurations using ListProvisionConfigs - Function Compute - Alibaba Cloud -

Queries configurations of provisioned instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fc:ListProvisionConfigs

get

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
limit	integer	No	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
nextToken	string	No	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
serviceName	string	No	The name of the service to which resources belong.	serviceName
qualifier	string	No	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-Id	string	No	The ID of your Alibaba Cloud account.	188077086902****
X-Fc-Date	string	No	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-Id	string	No	The trace ID of the request for Function Compute API.	rid281s******

Response elements

Element	Type	Description	Example
	object	The list of provisioned instance configurations.
nextToken	string	The token used to obtain more results.	demoNextToken
provisionConfigs	array<object>	The provisioned instance configurations.
	object	The provisioned configuration details.
resource	string	The description of the resource.	12345#servierName#qualifier#functionName
target	integer	The expected number of resources.	5
current	integer	The number of current resources.	5
scheduledActions	array	The configurations of scheduled auto scaling.
	ScheduledActions	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 * *)" } ]
targetTrackingPolicies	array	The metric-based scaling policy.
	TargetTrackingPolicies	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, } ]
currentError	string	The error message returned if a provisioned instance fails to be created.	image not found
alwaysAllocateCPU	boolean	Specifies whether to always allocate CPU resources to function instances.	true

Examples

Success response

JSON format

{
  "nextToken": "demoNextToken",
  "provisionConfigs": [
    {
      "resource": "12345#servierName#qualifier#functionName",
      "target": 5,
      "current": 5,
      "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.