获取单个服务信息

最近更新时间：2023.05.26 11:55:03

首次发布时间：2021.02.23 10:42:23

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

请求说明

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

说明

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

请求参数

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

Query

参数类型是否必填描述

Action String 是接口名称。

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

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

ServiceId

String

是

服务 ID。

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

返回参数

参数	类型	描述
ServiceName	String	服务名称。
ServiceId	String	指定的服务 ID。
ServiceRegion	String	服务地域，取值如下所示： cn：中国 va：美东 sg：新加坡
ServiceType	String	服务类型，取值如下所示： StaticRc：素材托管服务 Image：图片处理服务
ServiceStatus	String	服务状态。状态分为未审核、审核未通过、正常、禁用。说明只有服务状态为正常时，该服务才可用。如果是其他异常状态，请参考服务管理进行处理。
CreateAt	String	服务创建时间，即创建时当地服务器时间。
HasSigkey	Bool	服务是否已经配置鉴权 key，取值如下所示： true：已配置 false：未配置
TemplatePrefix	String	该服务的图片模板固定前缀。
DomainInfos	Array of DomainInfos	绑定域名的相关信息。
PrimaryKey	String	主鉴权 Key。
SecondaryKey	String	备鉴权 Key。
ObjectAccess	Bool	是否开启源地址访问，默认关闭，取值如下所示： true：开启 false：关闭
CompactURL	Bool	是否开启精简 URL，取值如下所示： true：开启 false：关闭
Mirror	Object of Mirror	镜像回源配置，默认关闭。
Storage	Object of Storage	资源配置。
AllowBkts	Array of String	服务的授权 Bucket 列表。

Storage

参数	类型	描述
BktName	String	存储 Bucket 名称。
TTL	Integer	保存时间，单位为秒。
AllTypes	Bool	是否支持任意文件格式上传，取值如下所示： true：支持 false：不支持

参数

类型

描述

BktName

String

存储 Bucket 名称。

TTL

Integer

保存时间，单位为秒。

AllTypes

Bool

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

true：支持
false：不支持

DomainInfos

参数	类型	描述
DomainName	String	绑定的域名。
CNAME	String	域名解析到的 cname。
Status	String	域名状态。
IsDefault	Bool	是否默认域名，取值如下所示： true：默认域名 false：非默认域名

Mirror

参数	类型	描述
Schema	String	下载图片的协议，支持取值：`http`、`https`。
Host	String	镜像回源域名。
Hosts	JSON Map	带权重回源域名，key 为 String 类型时，代表镜像回源域名；value 为 Integer 类型时，代表域名权重。
Source	String	镜像源 URI，其中图片名用 %s 占位符替代，比如/obj/%s。
Headers	JSON Map	镜像回源下载原图时，携带的 HTTP 头部，键值都为 String 类型。

示例

请求示例

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

正常返回示例

{
    "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
        }
    }
}

异常返回示例

{
    "ResponseMetadata":{
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetImageService",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
        "Error": {
            "Code": "RetrieveServiceFailure",
            "Message": "Service not found."
        }
    }
}

错误码

访问公共错误码和服务相关错误码获取详细信息。