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

文档中心

立即注册

导航

veImageX

获取可用字体

最近更新时间：2024.09.03 16:47:46首次发布时间：2024.04.19 11:39:02

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

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 10 秒。
服务地址：仅支持使用国内对应的 OpenAPI 域名，具体请见请求地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetImageFonts&Version=2023-05-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageFonts`	接口名称。当前 API 的名称为 `GetImageFonts`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Fonts	Array of Fonts	`-`	字体列表。

Fonts

参数	类型	示例值	描述
Name	String	`思源黑体`	字体中文名称，如思源黑体。
Font	String	`SourceHanSans-Regular.ttf`	字体值，即字体库字体名称。
Uri	String	`nephogramlogo/SourceHanSans-Regular.ttf`	字体资源 URI。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageFonts&Version=2023-05-01

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageFonts",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Fonts": [
            {
                "Name": "思源黑体",
                "Font": "SourceHanSans-Regular.ttf",
                "Uri": "nephogramlogo/SourceHanSans-Regular.ttf"
            }
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

历史版本

2018-08-01 版本 GetImageFonts 接口文档现已停止维护，建议您参考本文档使用最新版本。