获取可用字体--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取可用字体

最近更新时间：2024.12.25 15:42:37首次发布时间：2022.07.20 11:14:32

获取创意魔方内当前可用的字体中文名称、字体资源 Uri 等可用字体详情。

说明

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

请求说明

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

说明

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

请求参数

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

Query

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

返回参数

参数	类型	描述
Fonts	Array of Fonts	字体列表。

Fonts

参数	类型	描述
Name	String	字体中文名称，如思源黑体。
Font	String	字体值，即字体库字体名称。
Uri	String	字体资源 URI。

示例

请求示例

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

正常返回示例

"ResponseMetadata":{
      "RequestId":"202207181437480102121020921AF04658",
      "Action":"GetImageFonts",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
      "Fonts":[
         {
            "Name":"思源黑体",
            "Font":"SourceHanSans-Regular.ttf",
            "Uri":"nephogramlogo/SourceHanSans-Regular.ttf"
         }
   }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202207181437480102121020921AF04658",
        "Action": "GetImageFonts",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
             "Code": "xx",
            "Message": "xx"
        }
    }
}

错误码

访问公共错误码和创意魔方错误码获取详细信息。