CreateServiceInstance - 创建并部署服务实例

通过指定地域ID、服务ID、服务版本等参数,创建并部署服务实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。可能的值:

  • cn-hangzhou:华东 1(杭州) 。

  • ap-southeast-1:新加坡。

cn-hangzhou
Namestring

服务实例名称。格式要求如下:

  • 长度不超过 64 个字符。

  • 必须以数字或英文字母开头,可包含数字、英文字母、短划线(-)和下划线(_)。

TestName
ServiceIdstring

服务 ID。

service-0e6fca6a51a54420****
ServiceVersionstring

服务版本。

1
Parametersobject

服务实例部署的参数。

说明 若服务实例包含部署地域信息,则需在部署参数中填写。
{ "RegionId": "cn-hangzhou" "NodeCount": 3, "SystemDiskSize": 40, "InstancePassword": "******" }
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。

123e4567-e89b-12d3-a456-426655440000
TemplateNamestring

模板名称,服务支持多模板时需要指定模板名称。

模板1
ResourceGroupIdstring

资源组 ID。

rg-aekzuqyxxxxxx
UserIdstring

用户 ID。

1563457855xxxxxx
Tagarray<object>

用户自定义标签。

object

用户自定义标签。

Keystring

标签键。

key1
Valuestring

标签值。

value1
SpecificationNamestring

套餐规格名称。

套餐一
DryRunboolean

是否对此次创建请求执行预检,包括权限、实例状态校验等。可能的值:

  • true:发送请求,不创建服务实例。

  • false:发送请求,检查通过后创建服务实例。

false
EndTimestring

服务实例的释放时间。

说明 仅支持托管版场景中,服务商对自己的服务实例设置该参数。
2023-12-12T03:13:05Z

返回参数

名称类型描述示例值
object
Statusstring

服务实例状态。可能值:

  • Created:已创建。

  • Deploying:部署中。

  • DeployedFailed:部署失败。

  • Deployed:已部署。

  • Upgrading:升级中。

  • Deleting:删除中。

  • Deleted:已删除。

  • DeletedFailed:删除失败。

Created
RequestIdstring

请求 ID。

4DB0F536-B3BE-4F0D-BD29-E83FB56D****
ServiceInstanceIdstring

服务实例 ID。

si-d6ab3a63ccbb4b17****

示例

正常返回示例

JSON格式

{
  "Status": "Created",
  "RequestId": "4DB0F536-B3BE-4F0D-BD29-E83FB56D****",
  "ServiceInstanceId": "si-d6ab3a63ccbb4b17****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-11OpenAPI 入参发生变更查看变更详情
2023-08-11OpenAPI 入参发生变更查看变更详情
2022-05-09新增 OpenAPI查看变更详情