本接口支持获取当前火山账号下创建的所有 veImageX 图片服务信息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetAllImageServices | 接口名称。当前 API 的名称为 GetAllImageServices 。 |
Version | String | 是 | 2018-08-01 | 接口版本。当前 API 的版本为 2018-08-01 。 |
SearchPtn | String | 否 | test | 筛选服务的参数,当该值为空时返回所有服务,指定后返回服务名或者 ID 中包含该字符串的服务。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Services | Array of Services | - | 所有的服务信息。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ServiceName | String | test | 服务名称。 |
ServiceId | String | zh**1q | 服务 ID。 |
ServiceRegion | String |
| 服务地域,取值如下所示:
|
ServiceType | String |
| 服务类型,取值如下所示:
|
ServiceStatus | String |
| 服务状态。状态分为未审核、审核未通过、正常、禁用。 说明
|
CreateAt | String | 2023-05-05 19:20:13 | 服务创建时间,即创建时当地服务器时间。 |
HasSigkey | Boolean |
| 是否配置鉴权 key,取值如下所示:
|
TemplatePrefix | String | tplv-zh**1q- | 该服务的图片模板固定前缀。 |
DomainInfos | Array of DomainInfos | - | 绑定域名的相关信息。 |
PrimaryKey | String | abcd****qrst | 主鉴权 Key。 |
SecondaryKey | String | 9819***1bbc12 | 备鉴权 Key。 |
ObjectAccess | Boolean |
| 是否开启源地址访问,取值如下所示:
|
CompactURL | Boolean |
| 是否开启精简 URL,取值如下所示:
|
Mirror | Object of Mirror | - | 镜像回源配置。 |
Storage | Object of Storage | - | 资源配置。 |
AllowBkts | Array of String | ["tos-cn-i-zh**1q"] | 服务的授权 Bucket 列表。 |
UploadOverwrite | Boolean |
| 是否开启覆盖上传,取值如下所示:
|
EventRules | Array of EventRules | - | 事件通知配置 |
ImageYAttribute | Object of ImageYAttribute | - | 自定义处理样式具体配置 |
AllowMirrorTypes | Boolean |
| 是否允许配置其他镜像站类型,取值如下所示:
|
ProjectName | String | default | 服务绑定的项目 |
ResourceTags | Array of ResourceTags | - | 服务绑定的标签 |
VodSpace | Object of VodSpace | - | 绑定点播空间配置 |
StorageRules | Array of StorageRules | - | 降冷存储配置 |
ResourceLimitedVisit | Object of ResourceLimitedVisit | - | 资源封禁配置 |
StorageVersioning | Integer |
| 版本控制启用状态,取值如下所示:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DomainName | String | *.test.imagex.cn | 绑定的域名。 |
CNAME | String | *.test.imagex.cn.imagex.xxx.com | 域名解析到的 cname。 |
Status | String | 正常 | 域名状态。 |
IsDefault | Boolean |
| 是否为默认域名,取值如下所示:
|
UrlAuth | Boolean |
| 是否开启鉴权,取值如下所示:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Schema | String |
| 下载图片的协议,取值如下所示:
|
Host | String | img.example.com | 镜像回源域名。 |
Hosts | JSON Map | { "test.com": 100, "test1.com": 0 } | 带权重回源域名,key 为 String 类型时,代表镜像回源域名;value 为 Integer 类型时,代表域名权重。 |
Source | String | /obj/%s | 镜像源 URI,其中图片名用 %s 占位符替代,比如/obj/%s。 |
Headers | JSON Map | { "name": "app1" } | 镜像回源下载原图时,携带的 HTTP 头部,键值都为 String 类型。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
BktName | String | tos-cn-i-fc*****cf | 存储 Bucket 名称。 |
AllTypes | Boolean |
| 是否支持任意文件格式上传,取值如下所示:
|
TTL | Long | 0 | 保存时间,单位为秒。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 0180***12681 | 规则 ID |
EventType | Array of String |
| 事件类型。取值如下所示:
|
MatchRule | String | \test\.png\b | 匹配规则的正则表达式。 |
CallbackUrl | String | https://a.callback.com | 事件触发时接收回调的回调 URL。 |
Enable | Boolean |
| 规则启用状态,取值如下所示:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ResourceProtect | Boolean |
| 是否开启原图保护,取值如下所示:
|
StyleSeparators | Array of String | ["@"] | 样式分割符 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Value | String | userValue | 标签值 |
Key | String | userKey | 标签键 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
SpaceName | String | test1 | 点播空间名 |
Region | String | cn-north-1 | 空间所在地区 |
Bucket | String | tos-cn-v-7**1 | 点播空间存储桶名称 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Prefix | String | prefix | 文件前缀。例如设置为 prefix 后,规则将只对名称以 prefix 开头的存储资源生效。 |
Event | String | upload | 策略类型,固定取值 Upload ,表示按上传时间。 |
Day | Integer | 30 | 策略天数,单位为天。按照 Event 事件 Day 天后执行 Action 事件,即当匹配文件的上传时间符合指定天数后,自动按照处理策略对资源进行处理。 |
Action | String |
| 策略命中后需要执行的操作,取值如下所示:
|
Enable | Boolean |
| 是否启用策略,取值如下所示:
|
NonCurrentDay | Integer | 30 | 历史版本文件的策略天数 |
NonCurrentAction | String | IA | 历史版本文件在策略命中后需要执行的操作 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Enable | Boolean |
| 资源封禁开关,取值如下所示:
|
AllowDomains | Array of String | ["test.example.com"] | 域名白名单列表,封禁资源仅可被白名单的域名访问。 |
GET https://imagex.volcengineapi.com/?Action=GetAllImageServices&Version=2018-08-01&SearchPtn=
{ "ResponseMetadata": { "RequestId": "2022082920380201020803721701755F97", "Action": "GetAllImageServices", "Version": "2018-08-01", "Service": "imagex", "Region": "cn-north-1" }, "Result": { "Services": [ { "ServiceName": "test", "ServiceId": "zh**1q", "ProjectName": "default", "ServiceRegion": "cn", "ServiceStatus": "正常", "ServiceType": "Image", "CompactStore": true, "ImageY": false, "CompactHeaderPass": false, "AllowVolcTos": false, "HasSigkey": false, "CreateAt": "2023-05-05 19:20:13", "Creator": "img_test", "SecurityContact": "", "TemplatePrefix": "tplv-zh**1q-", "DomainNames": [], "DomainInfos": [ { "DomainName": "*.test.imagex.cn", "CNAME": "*.test.imagex.cn.imagex.xxx.com", "Status": "正常", "IsDefault": false } ], "PrimaryKey": "", "SecondaryKey": "", "ObjectAccess": true, "CompactURL": true, "AllowBkts": [ "tos-cn-i-zh**1q" ], "AllowServices": [], "Mirror": { "Schema": "", "Host": "", "Hosts": null, "Source": "", "Headers": {} }, "Storage": { "BktName": "tos-cn-i-zh**1q", "TTL": 0, "AllTypes": false }, "StoreAttr": 0, "PrivacyLevel": "", "VolTosBucket": null, "Auditor": "", "UploadOverwrite": false, "ContentTypeCfg": null, "ImageYAttribute": { "ImageStyleSeparators": [ "~" ] } } ] } }
本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。