文档中心

获取增值能力配置

最近更新时间：2024.03.13 16:37:56

首次发布时间：2021.02.23 10:42:29

本接口支持获取已发布且对应账号可见的增值能力配置数据，如使用的增值能力组件 ID、能力名称等信息。

请求说明

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

说明

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

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
Tag	String	否	组件所属功能属性标签。默认为空则返回所有组件信息，多个标签使用逗号分隔。您可以参考获取组件标签列表详情获取附加组件标签名称。
SearchPtn	String	否	返回名称或描述信息中包含此字段的组件信息。默认为空，返回所有组件。
ID	String	否	组件 ID。返回 ID 等于该值的组件信息。默认为空，返回所有组件。

返回参数

参数	类型	描述
AddOn	Array of AddOn	组件配置数据。

AddOn

参数	类型	描述
ID	String	组件 ID。
Name	String	组件名称。
Key	String	组件英文标识，服务端组件时取值为对应模板编辑操作名称。
Feat	String	组件服务特征，例如：silm、ocr。
Icon	String	组件图标 URI。
Preview	String	预览图 URI。
Tag	Array of String	组件所属功能属性标签。
Tags	JSON Map	组件自定义标签。Key 为 String，Value 为 Array of String。
Desc	String	组件描述信息。
Platform	Array of String	组件支持平台列表。取值范围：Android、iOS、WEB、server。
Region	Array of String	组件支持地域列表。取值如下所示： cn：国内 sg：新加坡
Detail	String	组件详细介绍。
DetailTemplate	String	组件详情页模板。
ConfInfos	Array of ConfInfos	组件对应商品配置信息。
Status	Integer	组件状态，取值如下所示： 0：公测中 1：未开通 2：已开通
AuthStatus	String	组件授权状态。取值为空表示无需授权。取值为`auth`表示需要下发授权码但不需要人工审核。取值为`auth_admin`表示需要下发授权码且需要人工审核。
InstanceID	String	组件功能对应实例 ID，仅当`Status`取值为`2`时有值。
Configuration	String	实例 ID 对应商品配置，仅当`Status`取值为`2`时有值。
PublishAt	String	发布时间，发布时服务器当地时间。
PublishWhite	Bool	是否白名单发布。取值如下所示： true：白名单发布 false：不是白名单发布
WhiteList	Array of String	白名单账号列表。

ConfInfos

参数	类型	描述
Configuration	String	商品计费配置标识。
ConfigurationDescription	String	商品计费配置中文描述。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageAddOnConf&Version=2018-08-01

正常返回示例

{
   "ResponseMetadata":{
      "RequestId":"20220829201636010208037215157DC5AC",
      "Action":"GetImageAddOnConf",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
      "AddOn":[
         {
            "ID":"A-b46a4a04-3a26-4dce-9cb6-d133157234ed",
            "Name":"集智瘦身",
            "Key":"slim",
            "Feat":"slim",
            "Icon":"imagex-common/7d37f***ffb",
            "Preview":"imagex-common/70f90***8b9",
            "Tag":[
               "智能图像处理"
            ],
            "Tags":{
               "type":[
                  "智能图像处理"
               ],
               "功能属性":[
                  "智能图像处理"
               ]
            },
            "Desc":"集智瘦身***。",
            "Platform":[
               "server"
            ],
            "Region":[
               "cn"
            ],
            "Detail":"*****",
            "DetailTemplate":"custom",
            "ConfInfos":[
               {
                  "Configuration":"imagex.monthly.slim",
                  "ConfigurationDescription":" 附加组件_集智瘦身 （按月结算）"
               }
            ],
            "Status":2,
            "AuthStatus":"",
            "PublishWhite":false,
            "WhiteList":[
               
            ],
            "PublishAt":"2022-06-07 11:34:36",
            "InstanceID":"Imagex7107495094266040613",
            "Configuration":"imagex.monthly.slim"
         }
      ]
   }
}

异常返回示例

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

错误码

访问错误码和附加组件错误码获取详细信息。