创建服务

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

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

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

请求说明

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

说明

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

请求参数

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

Query

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

Body

参数	类型	是否必须	描述
ServiceName	String	是	服务名称，最多不超过 32 个字符。
ServiceRegion	String	是	服务地域，取值如下所示： cn：中国； va：美东； sg：新加坡。
ServiceType	String	否	服务类型，取值如下所示： StaticRc：素材托管服务； Image：图片处理服务。
Domains	Array of Domains	是	创建服务时绑定的域名列表

Domains

参数	类型	是否必须	描述
Domain	String	是	待绑定的已备案域名。
CertID	String	否	待绑定的证书 ID。

返回参数

参数	类型	描述
ServiceName	String	服务的名称。
ServiceId	String	创建的服务 ID。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageService&Version=2018-08-01

{
    "ServiceName": "picture_1",
    "ServiceRegion": "cn",
    "Domains": [
    {
        "Domain": "a.test.com"
    }
   ]
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "CreateImageService",
        "Version": "2018-08-01",
	    	"Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "ServiceName": "picture_1",
        "ServiceId": "d7b84a******4a"
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "CreateImageService",
        "Version": "2018-08-01",
    		"Service": "imagex",
	    	"Region": "cn-north-1"
        "Error": {
            "Code": "CreateServiceFailure",
            "Message": "Invalid service region."
        }
    }
}

错误码

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

请求说明

请求参数

Query

Body

Domains

返回参数

示例

请求示例

正常返回示例

异常返回示例

错误码