最近更新时间：2023.07.28 15:16:36
首次发布时间：2021.02.23 10:42:23
本接口支持获取当前火山账号下创建的所有 veImageX 图片服务信息。
说明
veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetAllImageServices | 接口名称。当前 API 的版本为 GetAllImageServices。 |
| Version | String | 是 | 2018-08-01 | 接口版本。当前 API 的版本为 2018-08-01。 |
| SearchPtn | String | 否 | 7y***1i | 该值为空时返回所有服务，指定后返回服务名或者 ID 中包含该字符串的服务。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Services | Array of Services | 所有的服务信息。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ServiceName | String | ImageX服务 | 服务名称。 |
| ServiceId | String | 7y***1i | 指定的服务 ID。 |
ServiceRegion | String |
| 服务地域，取值如下所示：
|
ServiceType | String |
| 服务类型，取值如下所示：
|
ServiceStatus | String |
| 服务状态。状态分为未审核、审核未通过、正常、禁用。 说明
|
| CreateAt | String | 2018-05-09 17:44:40 | 服务创建时间，即创建时当地服务器时间。 |
HasSigkey | Bool |
| 服务是否已经配置鉴权 key，取值如下所示：
|
| TemplatePrefix | String | tplv-fc*****cf- | 该服务的图片模板固定前缀。 |
| DomainInfos | Array of DomainInfos | 绑定域名的相关信息。 | |
| PrimaryKey | String | s1g2b75**PeZZ4f | 主鉴权 Key。 |
| SecondaryKey | String | HYPe178**2hZZ4f | 备鉴权 Key。 |
ObjectAccess | Bool |
| 是否开启源地址访问，取值如下所示：
|
CompactURL | Bool |
| 是否开启精简 URL，取值如下所示：
|
| Mirror | Object of Mirror | 镜像回源配置。 | |
| Storage | Object of Storage | 资源配置。 | |
| AllowBkts | Array of String | tos-cn-i-fc*****cf | 服务的授权 Bucket 列表。 |
UploadOverwrite | Boolean |
| 是否开启覆盖上传，取值如下所示：
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| BktName | String | tos-cn-i-fc*****cf | 存储 Bucket 名称。 |
| TTL | Integer | 0 | 保存时间，单位为秒。 |
AllTypes | Bool |
| 是否支持任意文件格式上传，取值如下所示：
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| DomainName | String | imgtest.a.org | 绑定的域名。 |
| CNAME | String | imgtest.a.org.bytedance.com | 域名解析到的 cname。 |
| Status | String | 正常 | 域名状态。 |
IsDefault | Bool |
| 是否是默认域名，取值如下所示：
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Schema | String | http | 下载图片的协议，支持取值：http、https。 |
| Host | String | test.com | 镜像回源域名。 |
Hosts | JSON Map |
| 带权重回源域名，key 为 String 类型时，代表镜像回源域名；value 为 Integer 类型时，代表域名权重。 |
| Source | String | /a/b/test%s | 镜像源 URI，其中图片名用 %s 占位符替代，比如/obj/%s。 |
Headers | JSON Map |
| 镜像回源下载原图时，携带的 HTTP 头部，键值都为 String 类型。 |
GET https://imagex.volcengineapi.com/?Action=GetAllImageServices&Version=2018-08-01&SearchPtn=picture
{ "ResponseMetadata":{ "RequestId":"2022082920380201020803721701755F97", "Action":"GetAllImageServices", "Version":"2018-08-01", "Service":"imagex", "Region":"cn-north-1" }, "Result": { "Services": [ { "ServiceName": "picture_1", "ServiceId": "fc*****cf", "ServiceRegion": "cn", "CreateAt": "2018-05-09 17:44:40", "ServiceStatus": "正常", "HasSigkey": false, "TemplatePrefix": "tplv-fc*****cf-", "UploadOverwrite": "false", "DomainInfos": [{ "DomainName": "test", "CNAME": "test.bytedance.com", "Status": "正常", "IsDefault": true }], "ObjectAccess": false, "CompactURL": false, "AllowBkts": ["tos-cn-i-fc*****cf"], "Mirror": { "Schema": "http", "Host": "test.com", "Hosts": { "test.com": 100, "test1.com": 0 }, "Source": "/a/b/test%s", "Headers": { "name": "app1" } }, "Storage": { "BktName": "tos-cn-i-fc*****cf", "TTL": 0, "AllTypes": false } } ] } }