You need to enable JavaScript to run this app.
导航
获取规则列表
最近更新时间:2024.08.20 11:34:24首次发布时间:2021.02.23 10:42:28

本接口支持指定 APPID 以及配置项 ID,来获取配置项下的规则列表信息。

说明

该接口属于历史版本 API,建议您使用新版 GetImageSettingRules 接口。

请求说明

  • 接口名称:GetImageSettingRules
  • 请求方式:GET
  • 接口地址示例:https://imagex.volcengineapi.com/?Action=GetImageSettingRules&Version=2018-08-01
  • 请求频率限制:10 次/秒
  • 超时时间:5 秒

说明

veImageX 在全球多个区域部署,每个区域有自己对应的 openAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数

Query

参数类型是否必选描述
ActionString接口名称。
VersionString接口版本。veImageX 当前 API 的版本为 2018-08-01

AppId

String

应用 ID。

说明

您可以通过调用获取应用列表的方式获取所需的 AppId。

SettingId

String

配置项 ID。

说明

您可以通过调用获取配置项列表的方式获取所需的配置项 ID。

返回参数

参数类型描述
NameString规则所属配置项名称。

Type

String

规则所属配置项类型。

  • 取值为sample表示采样率类型;
  • 取值为integer表示整数类型;
  • 取值为float表示浮点数类型;
  • 取值为string表示字符串类型;
  • 取值为strarr表示字符串数组类型;
  • 取值为bool表示布尔值类型;
  • 取值为parent表示父节点类型;
  • 取值为object表示对象类型。
ValueTypeString仅当Type取值为object时有值,表示 value 类型,key 类型统一为 String。
CommentString规则所属配置项备注信息。
DefaultValue类型由Type决定规则所属配置项默认值,仅当Type值不是parent时有意义。

ValueRange

Object

取值限制范围。仅当Type 取值为integer/float/sample /object时有效。

说明

Type取值为object时,表示ValueType的取值范围。

RulesArray of Rule规则列表。
AppIdString应用 ID。
AppRegionString应用地域。

Category

String

所属组件。

  • 返回值为HEIF时,表示 HEIF 解码库;
  • 返回值为SR时,表示图像超分辨率(客户端)。
ParentIdString父节点 ID,若本身为父节点,则该值为空。
SettingIdString配置项 ID。
StatusIntrger配置项状态,仅支持取值为0,表示状态正常。
UpdateAtString修改时间,修改时的服务器当地时间。

ValueRange

参数类型描述
Lower类型由Type决定取值下限。
Upper类型由Type决定取值上限。

Rule

参数类型描述
RuleIdString规则 ID。
PriorityInteger规则优先级,值越小优先级越高。
NameString规则名称。
ContentString规则配置信息。
CondRuleCond规则条件。
Value类型由对应配置项类型决定对应配置值。
CreatorString规则创建人。

RuleCond

参数类型描述
TypeString匹配条件。取值AND表示与,OR表示或。
CondsArray of RuleCond条件列表。
KeyString过滤维度。
OpString操作符。支持取值:==、!=、>、>=、<、<=、in
Value类型由Op决定配置值。Opin时为 Array of String 类型,取值为其他时为 String 类型。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageSettingRules&Version=2018-08-01&AppId=179132&SettingId=S-ccedaa3b-a914-4275-90ed-514300b40d*

正常返回示例

{
   "ResponseMetadata":{
      "RequestId":"202208161724370102091570361F9F96F9",
      "Action":"GetImageSettingRules",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
      "AppId":"394325",
      "SettingId":"S-ccedaa3b-a914-4275-90ed-514300b40d40",
      "ParentId":"S-6c040a73-7f60-44f7-b3d0-d13942dcc752",
      "Status":0,
      "Name":"imagex_load_monitor",
      "Type":"sample",
      "Comment":"客户端日志上报采样率",
      "DefaultValue":0.5,
      "ChildSettings":[
         
      ],
      "Rules":[
         
      ],
      "AppRegion":"cn",
      "Region":"",
      "Category":"",
      "Public":"",
      "UpdateAt":"2022-06-20 17:06:14"
   }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
				"Action": "GetImageSettingRules",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "",
            "Message": ""
        }
    }
}

错误码

访问公共错误码客户端配置下发相关错误码获取详细信息。