ListEngineConfigs - 获取引擎配置列表

获取引擎配置列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
pairec:ListEngineConfigslist
*全部资源
*

请求语法

GET /api/v1/engineconfigs HTTP/1.1

请求参数

名称类型必填描述示例值
Environmentstring

运行环境。

  • Daily:日常环境。

  • Pre:预发环境。

  • Prod:生产环境。

Pre
Statusstring

状态过滤。

  • Released:已发布。

  • Unreleased:未发布。

Released
Namestring

引擎配置名称。

engine_config_v1
PageNumberinteger

页码。

1
PageSizeinteger

分页的大小。

10
Versionstring

版本过滤。

latest:最近一次更新的版本。

latest
InstanceIdstring

实例 ID,可通过接口 ListInstances 获取。

pairec-cn-***test

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

74D958EF-3598-56FA-8296-FF1575CE43DF
TotalCountlong

列表内元素总数。

10
EngineConfigsarray<object>

引擎配置列表。

EngineConfigsobject
EngineConfigIdstring

引擎配置 Id。

2
Namestring

引擎配置名称。

engine_config_v1
ConfigValuestring

引擎配置的内容。

{}
Environmentstring

运行环境。

  • Daily:日常环境。

  • Pre:预发环境。

  • Prod:生产环境。

Pre
Versionstring

当前发布的/最近更新的版本对应的版本号。

20230509161300
Statusstring

状态。

  • Released:已发布。

  • UnReleased:未发布。

Released
GmtCreateTimestring

创建时间。

2023-08-07T01:43:42Z
GmtModifiedTimestring

更新时间。

2023-08-27T12:00:00Z
GmtReleasedTimestring

发布时间。

2023-08-29 12:00:00

示例

正常返回示例

JSON格式

{
  "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": ""
    }
  ]
}

错误码

访问错误中心查看更多错误码。