ListEngineConfigs-阿里云帮助中心

Retrieves a list of engine configurations.

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

pairec:ListEngineConfigs

list

*All Resource

*

None

Request syntax

GET /api/v1/engineconfigs HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Environment	string	No	The runtime environment. Valid values: Daily: Daily environment. Pre: Pre-release environment. Prod: Production environment.	Pre
Status	string	No	The status filter. Valid values: Released: Released. Unreleased: Not released.	Released
Name	string	No	The engine configuration name.	engine_config_v1
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10
Version	string	No	The version filter. Valid values: latest: the most recently updated version.	latest
InstanceId	string	Yes	The instance ID. You can obtain the instance ID by calling the ListInstances operation.	pairec-cn-***test

Response elements

Element	Type	Description	Example
	object	Schema of Response
EngineConfigs	array<object>	The list of engine configurations.
	object
ConfigValue	string	The content of the engine configuration.	{}
Description	string	The description.	what
EngineConfigId	string	The engine configuration ID.	2
Environment	string	The runtime environment. Valid values: Daily: Daily environment. Pre: Pre-release environment. Prod: Production environment.	Pre
GmtCreateTime	string	The creation time.	2023-08-07T01:43:42Z
GmtModifiedTime	string	The update time.	2023-08-27T12:00:00Z
GmtReleasedTime	string	The release time.	2023-08-29 12:00:00
Name	string	The engine configuration name.	engine_config_v1
SceneId	string	The scene ID.	1
Status	string	The status. Valid values: Released: Released. UnReleased: Not released.	Released
Type	string	The engine configuration type.	Normal
Version	string	The version number of the currently released or most recently updated version.	20230509161300
RequestId	string	The request ID.	74D958EF-3598-56FA-8296-FF1575CE43DF
TotalCount	integer	The total number of entries in the list.	10

Examples

Success response

JSON format

{
  "EngineConfigs": [
    {
      "ConfigValue": "{}",
      "Description": "what",
      "EngineConfigId": "2",
      "Environment": "Pre",
      "GmtCreateTime": "2023-08-07T01:43:42Z",
      "GmtModifiedTime": "2023-08-27T12:00:00Z",
      "GmtReleasedTime": "2023-08-29 12:00:00",
      "Name": "engine_config_v1",
      "SceneId": "1",
      "Status": "Released",
      "Type": "Normal",
      "Version": "20230509161300"
    }
  ],
  "RequestId": "74D958EF-3598-56FA-8296-FF1575CE43DF",
  "TotalCount": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.