通过指定服务名称、服务区域以及域名来创建一个图片服务,并得到返回的服务名称和服务 ID。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateImageService | 接口名称。当前 API 的名称为 CreateImageService 。 |
Version | String | 是 | 2023-05-01 | 接口版本。当前 API 的版本为 2023-05-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ServiceName | String | 是 | 图片处理 | 服务名称,最多不超过 32 个字符。创建成功后,名称和区域不支持变更。建议您使用能够标识业务的服务名。 |
ServiceRegion | String | 是 |
| 服务地域,取值如下所示:
|
ServiceType | String | 否 |
| 服务类型,取值如下所示:
|
Domains | Array of Domains | 是 | - | 创建服务时需要绑定的域名列表,最多支持一次绑定 10 个域名。 |
ProjectName | String | 否 | default | 服务绑定的项目,默认值为 default 。项目是在火山引擎访问控制中资源分组的概念,您需要将服务加入某一个项目中。您可以在火山引擎控制台项目管理页面中获取项目名称。 |
ResourceTags | Array of ResourceTags | 否 | - | 服务绑定的标签,默认为空,表示不绑定标签。可用于通过标签将不同业务类别、用途的存储服务进行分类管理,也适用于标签制授权和标签分账等场景。您可以在火山引擎控制台资源管理页面新建标签。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Domain | String | 是 | a.test.com | 待绑定的已备案域名。 |
CertID | String | 否 | 109jo**027y3 | 待绑定的证书 ID。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Key | String | 是 | userkey | 标签键 |
Value | String | 是 | uservalue | 标签值 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ServiceName | String | Test | 服务的名称。 |
ServiceId | String | d7b84a******4a | 创建的服务 ID。 |
POST https://imagex.volcengineapi.com/?Action=CreateImageService&Version=2023-05-01 { "ServiceName": "图片处理", "ServiceRegion": "cn", "ServiceType": "Image", "Domains": [ { "Domain": "a.test.com", "CertID": "109jo**027y3" } ], "ProjectName": "default", "ResourceTags": [ { "Key": "userkey", "Value": "uservalue" } ] }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "CreateImageService", "Version": "2023-05-01", "Service": "ImageX", "Region": "cn-north-1" }, "Result": { "ServiceName": "图片处理", "ServiceId": "d7b**dh8" } }
本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。
veImageX 提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。
2018-08-01 版本 CreateImageService 接口文档现已停止维护,建议您参考本文档使用最新版本。