获取单个服务信息--veImageX-火山引擎

文档中心

立即注册

导航

获取单个服务信息

最近更新时间：2024.11.15 13:33:59首次发布时间：2021.02.23 10:42:23

本接口支持通过指定服务 ID，获取对应服务的详情，如：服务名称、服务地域和服务类型等信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间约为 5 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetImageService&Version=2018-08-01

请求参数

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

Query

参数类型是否必选示例值描述

Action String 是 GetImageService 接口名称。当前 API 的名称为 GetImageService。

Version String 是 2018-08-01 接口版本。当前 API 的版本为 2018-08-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageService`	接口名称。当前 API 的名称为 `GetImageService`。
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	`90**1h`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

90**1h

服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

返回参数

参数	类型	示例值	描述
ServiceName	String	`picture_1`	服务名称。
ServiceId	String	`fc*****cf`	指定的服务 ID。
ServiceRegion	String	`cn`	服务地域，取值如下所示： `cn`：中国 `sg`：新加坡
ServiceType	String	`Image`	服务类型，取值如下所示： `StaticRc`：素材托管服务 `Image`：图片处理服务
ServiceStatus	String	`正常`	服务状态。状态分为未审核、审核未通过、正常、禁用。说明只有服务状态为正常时，该服务才可用。如果是其他异常状态，请参考服务管理进行处理。
CreateAt	String	`2018-05-09 17:44:40`	服务创建时间，即创建时当地服务器时间。
HasSigkey	Boolean	`false`	服务是否已经配置鉴权 key，取值如下所示： `true`：已配置 `false`：未配置
TemplatePrefix	String	`tplv-fc*****cf-`	该服务的图片模板固定前缀。
DomainInfos	Array of DomainInfos	`-`	绑定域名的相关信息。
PrimaryKey	String	`abcd****qrst`	主鉴权 Key。
SecondaryKey	String	`9819***1bbc12`	备鉴权 Key。
ObjectAccess	Boolean	`false`	是否开启源地址访问，取值如下所示： `true`：开启 `false`：关闭
CompactURL	Boolean	`false`	是否开启精简 URL，取值如下所示： `true`：开启 `false`：关闭
Mirror	Object of Mirror	`-`	镜像回源配置，默认关闭。
Storage	Object of Storage	`-`	资源配置。
AllowBkts	Array of String	`["tos-cn-i-fc*****cf"]`	服务的授权 Bucket 列表。
UploadOverwrite	Boolean	`true`	是否开启覆盖上传，取值如下所示： `true`：开启 `false`：关闭
EventRules	Array of EventRules	`-`	事件通知规则
AllowMirrorTypes	Boolean	`false`	是否允许配置其他镜像站类型，取值如下所示： `true`：是 `false`：否
ImageYAttribute	Object of ImageYAttribute	`-`	自定义处理相关配置
ImageY	Boolean	`true`	是否开启自定义处理样式，取值如下所示： `true`：是 `false`：否
RsaPublicKey	String	`key1`	用于保护「数据加密密钥」的密钥，只有加密上传的图片需要做处理时需要申请。
ProjectName	String	`default`	服务绑定的项目，默认为 default。
ResourceTags	Array of ResourceTags	`-`	服务绑定的标签。
VodSpace	Object of VodSpace	`-`	绑定的点播空间信息
StorageRules	Array of StorageRules	`-`	存储降冷策略
ResourceLimitedVisit	Object of ResourceLimitedVisit	`-`	资源封禁配置
StorageVersioning	Integer	`0`	版本控制的启用状态，取值如下所示： `0`：未开启 `1`：已开启 `2`：暂停

DomainInfos

参数	类型	示例值	描述
DomainName	String	`test`	绑定的域名。
CNAME	String	`test.bytedance.com`	域名解析到的 cname。
Status	String	`正常`	域名状态。
IsDefault	Boolean	`true`	是否是默认域名，取值如下所示： `true`：默认域名 `false`：非默认域名
UrlAuth	Boolean	`false`	是否开启鉴权，取值如下所示： `true`：开启 `false`：关闭

Mirror

参数	类型	示例值	描述
Schema	String	`http`	下载图片的协议，支持取值：`http`、`https`。
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 类型。

Storage

参数类型示例值描述

BktName String tos-cn-i-fc*****cf 存储 Bucket 名称。

TTL Long 0 保存时间，单位为秒。

参数	类型	示例值	描述
BktName	String	`tos-cn-i-fc*****cf`	存储 Bucket 名称。
TTL	Long	`0`	保存时间，单位为秒。
AllTypes	Boolean	`false`	是否支持任意文件格式上传，取值如下所示： `true`：支持 `false`：不支持

AllTypes

Boolean

false

是否支持任意文件格式上传，取值如下所示：

true：支持
false：不支持

EventRules

参数	类型	示例值	描述
Id	String	`0180**61990`	规则 ID
EventType	Array of String	`upload`	事件类型。取值如下所示： `Upload`：上传文件 `Delete`：删除文件 `Mirror`：镜像回源 `Migrate`：数据迁移 `OffTrans`：离线转码（仅图像处理服务可配置） `TplStore`：模板持久化存储（仅图像处理服务可配置）
MatchRule	String	`\test\.png\b`	匹配规则的正则表达式。
CallbackUrl	String	`https://a.callback.com`	事件触发时接收回调的回调 URL。
Enable	Boolean	`true`	规则是否被启用，取值如下所示： `true`：是 `false`：否

ImageYAttribute

参数类型示例值描述

参数	类型	示例值	描述
ResourceProtect	Boolean	`true`	是否开启原图保护，取值如下所示： `true`：开启 `false`：关闭
StyleSeparators	Array of String	`["@"]`	样式分割符

ResourceProtect

Boolean

true

是否开启原图保护，取值如下所示：

true：开启
false：关闭

StyleSeparators Array of String ["@"] 样式分割符

ResourceTags

参数	类型	示例值	描述
Key	String	`userKey`	标签键
Value	String	`userValue`	标签值

VodSpace

参数	类型	示例值	描述
SpaceName	String	`test1`	点播空间名
Region	String	`cn-north-1`	空间所在地区
Bucket	String	`tos-cn-v-7**1`	点播空间存储桶名称

StorageRules

参数	类型	示例值	描述
Prefix	String	`prefix`	文件前缀，例如设置为 `prefix` 后，规则将只对名称以 `prefix` 开头的存储资源生效。
Event	String	`upload`	策略类型，固定取值 `Upload`，表示按上传时间。
Day	Integer	`24`	策略天数，按照 Event 事件 Day 天后执行 Action 事件，即当匹配文件的上传时间符合指定天数后，自动按照处理策略对资源进行处理。
Action	String	`IA`	策略命中后需要执行的操作，取值如下所示： `DELETE`：删除文件 `IA`：文件转低频存储 `ARCHIVE`：文件转归档存储 `COLD_ARCHIVE`：文件转冷归档存储
Enable	Boolean	`true`	是否启用策略，取值如下所示： `true`：是 `false`：否
NonCurrentDay	Integer	`30`	历史版本文件的策略天数
NonCurrentAction	String	`IA`	历史版本文件在策略命中后执行的具体操作

ResourceLimitedVisit

参数类型示例值描述

参数	类型	示例值	描述
Enable	Boolean	`true`	资源封禁开关，取值如下所示： `true`：开启 `false`：关闭
AllowDomains	Array of String	`["test.example.com"]`	域名白名单列表，封禁资源仅可被白名单的域名访问。

Enable

Boolean

true

资源封禁开关，取值如下所示：

true：开启
false：关闭

AllowDomains Array of String ["test.example.com"] 域名白名单列表，封禁资源仅可被白名单的域名访问。

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "GetImageService",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
    "ServiceName": "picture_1",
    "ServiceId": "fc*****cf",
    "ServiceRegion": "cn",
    "CreateAt": "2018-05-09 17:44:40",
    "ServiceStatus": "正常",
    "HasSigkey": false,
    "TemplatePrefix": "tplv-fc*****cf-",
    "DomainInfos": [
      {
        "DomainName": "test",
        "CNAME": "test.bytedance.com",
        "Status": "正常",
        "IsDefault": true
      }
    ],
    "ObjectAccess": false,
    "CompactURL": false,
    "AllowBkts": [
      "tos-cn-i-fc*****cf"
    ],
    "Mirror": {},
    "Storage": {
      "BktName": "tos-cn-i-fc*****cf",
      "TTL": 0,
      "AllTypes": false
    }
  }
}

错误码

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