GetEngineConfig-阿里云帮助中心

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:GetEngineConfig

get

*All Resource

*

None

Request syntax

GET /api/v1/engineconfigs/{EngineConfigId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
EngineConfigId	string	No	The engine configuration ID.	9

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID. You can obtain the instance ID by calling ListInstances.	pairec-cn-***test

Response elements

Element	Type	Description	Example
	object	Schema of Response
ConfigValue	string	The content of the engine configuration.	{}
Description	string	The description.	this is a test config
Environment	string	The runtime environment. Valid values: Daily: daily environment. Pre: staging environment. Prod: production environment.	Pre
GmtCreateTime	string	The creation time.	2024-01-03T02:28:00.000Z
GmtModifiedTime	string	The update time.	2024-08-27T12:00:00Z
GmtReleasedTime	string	The publish time.	2024-01-03 02:28:00
Name	string	The engine configuration name.	engine_config_v1
RequestId	string	The request ID.	59CE7EC6-F268-5D71-9215-32922CC50D72
SceneId	string	The scene ID.	1
Status	string	The status. Valid values: Released: published. UnReleased: not published.	Released
Type	string	The engine configuration type.	Normal

Examples

Success response

JSON format

{
  "ConfigValue": "{}",
  "Description": "this is a test config",
  "Environment": "Pre",
  "GmtCreateTime": "2024-01-03T02:28:00.000Z",
  "GmtModifiedTime": "2024-08-27T12:00:00Z",
  "GmtReleasedTime": "2024-01-03 02:28:00",
  "Name": "engine_config_v1",
  "RequestId": "59CE7EC6-F268-5D71-9215-32922CC50D72",
  "SceneId": "1",
  "Status": "Released",
  "Type": "Normal"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.