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 environment. Valid values: Daily: the development and test environment. Pre: the pre-production environment. Prod: the production environment.	Pre
Status	string	No	The status to filter by. Valid values: Released: returns only released configurations. Unreleased: returns only unreleased configurations.	Released
Name	string	No	The name of the engine configuration.	engine_config_v1
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The page size.	10
Version	string	No	The version to filter by. Set this parameter to `latest` to retrieve the most recently updated version.	latest
InstanceId	string	Yes	The instance ID. To obtain this ID, call the ListInstances operation.	pairec-cn-***test

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	74D958EF-3598-56FA-8296-FF1575CE43DF
TotalCount	integer	The total number of entries.	10
EngineConfigs	array<object>	A list of engine configurations.
	object
EngineConfigId	string	The ID of the engine configuration.	2
Name	string	The name of the engine configuration.	engine_config_v1
ConfigValue	string	The content of the engine configuration.	{}
Environment	string	The environment. Valid values: Daily: the development and test environment. Pre: the pre-production environment. Prod: the production environment.	Pre
Version	string	The version of the currently released or most recently updated engine configuration.	20230509161300
Status	string	The status of the engine configuration. Valid values: Released: The configuration has been released. Unreleased: The configuration has not been released.	Released
GmtCreateTime	string	The creation time.	2023-08-07T01:43:42Z
GmtModifiedTime	string	The modification time.	2023-08-27T12:00:00Z
GmtReleasedTime	string	The release time.	2023-08-29 12:00:00
Description	string	The description of the engine configuration.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.