创建服务--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

创建服务

最近更新时间：2024.08.05 18:26:06首次发布时间：2021.02.23 10:42:23

通过指定服务名称、服务区域以及域名来创建一个图片服务，并得到返回的服务名称和服务 ID。

说明

该接口属于历史版本 API，建议您使用新版 CreateImageService 接口。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ServiceName	String	是	`图片处理`	服务名称，最多不超过 32 个字符。创建成功后，名称和区域不支持变更。建议您使用能够标识业务的服务名。
ServiceRegion	String	是	`cn`	服务地域，取值如下所示： `cn`：中国； `sg`：新加坡。
ServiceType	String	否	`Image`	服务类型，取值如下所示： `StaticRc`：素材托管服务，支持任何合法资源的存储和分发。 `Image`：图片处理服务，除支持存储任意合法资源外，还支持对图片进行实时处理。
Domains	Array of Domains	是	`-`	创建服务时需要绑定的域名列表，最多支持一次绑定 10 个域名。
ProjectName	String	否	`default`	服务绑定的项目，默认值为 `default`。项目是在火山引擎访问控制中资源分组的概念，您需要将服务加入某一个项目中。您可以在火山引擎控制台项目管理页面中获取项目名称。
ResourceTags	Array of ResourceTags	否	`-`	服务绑定的标签，默认为空，表示不绑定标签。可用于通过标签将不同业务类别、用途的存储服务进行分类管理，也适用于标签制授权和标签分账等场景。您可以在火山引擎控制台资源管理页面新建标签。

Domains

参数	类型	是否必选	示例值	描述
Domain	String	是	`a.test.com`	待绑定的已备案域名。
CertID	String	否	`109jo**027y3`	待绑定的证书 ID。

ResourceTags

参数	类型	是否必选	示例值	描述
Key	String	是	`userkey`	标签键
Value	String	是	`uservalue`	标签值

返回参数

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

参数	类型	示例值	描述
ServiceName	String	`图片处理`	服务的名称。
ServiceId	String	`0h**1b`	创建的服务 ID。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageService&Version=2018-08-01
{
   "ServiceName":"图片处理",
   "Domains":[
      {
         "Domain":"a.test.com",
         "CertID":"109jo**027y3"
      }
   ],
   "ServiceRegion":"cn",
   "ServiceType":"Image",
   "ProjectName":"default"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "CreateImageService",
    "Version": "2018-08-01",
    "Service": "ImageX",
    "Region": "cn-north-1"
  },
  "Result": {
    "ServiceName": "图片处理",
    "ServiceId": "0h**1b"
  }
}

错误码

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