文档

CreateServiceInstance - 创建并部署服务实例

更新时间:

创建并部署服务实例。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
computenest:CreateServiceInstanceWrite
  • ServiceInstance
    acs:computenest:{#regionId}:{#accountId}:serviceinstance/*

请求参数

名称类型必填描述示例值
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
EnableInstanceOpsboolean

服务实例是否有代运维功能。取值范围:

  • true:服务实例有代运维功能。

  • false:服务实例没有代运维功能。

true
TemplateNamestring

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

模板1
OperationMetadataobject

代运维配置。

StartTimestring

运维开始时间,只在纯代运维模式下有效。

2021-12-29T06:48:56Z
EndTimestring

运维结束时间,只在纯代运维模式下有效。

2022-01-28T06:48:56Z
Resourcesstring

导入的资源列表。

{ "RegionId": "cn-hangzhou", "Type": "ResourceIds", "ResourceIds": { "ALIYUN::ECS::INSTANCE": ["i-xxx", "i-yyy"], "ALIYUN::RDS::INSTANCE": ["rm-xxx", "rm-yyy"], "ALIYUN::VPC::VPC": ["vpc-xxx", "vpc-yyy"], "ALIYUN::SLB::INSTANCE": ["lb-xxx", "lb-yyy"] } }
ServiceInstanceIdstring

导入的服务实例 ID。

si-d6ab3a63ccbb4b17****
ExtraInfostring

代运维服务附加信息。

```json { "vncInfo": [ { "instanceId": "i-001", "username": "admin", "password": "******", "vncPassword": "******" } ] } ```
ResourceGroupIdstring

资源组 ID。

rg-bp67acfmxazb4p****
ContactGroupstring

接收告警的云监控联系人组。

云账号报警联系人
TrialTypestring

当前服务实例的类型。可选值:

  • Trial:支持试用。

  • NotTrial:不支持试用。

Trial
Tagobject []

用户自定义标签。

Keystring

标签键。

key1
Valuestring

标签值。

value1
SpecificationNamestring

套餐规格名称。

套餐一
DryRunboolean

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

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

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

false
SpecificationCodestring

商品规格码。

yuncode5425200001
EnableUserPrometheusboolean

是否启用 Prometheus 监控,可能的值:

  • true:启用。

  • false:不启用。

true
Commodityobject

云市场购买订单信息,服务未上云市场或按量计费不必传。

PayPeriodUnitstring

购买时间单位,可传值:

  • Year:年。

  • Month:月。

  • Day:日。

Year
PayPeriodlong

购买时间长度。

1
AutoPayboolean

续费时是否自动付费。取值:

  • true:自动付费。
  • false:手动付费。

默认值:false

false

返回参数

名称类型描述示例值
object
Statusstring

服务实例状态。可能值:

  • Created:已创建。

  • Deploying:部署中。

  • DeployedFailed:部署失败。

  • Deployed:已部署。

  • Upgrading:升级中。

  • Deleting:删除中。

  • Deleted:已删除。

  • DeletedFailed:删除失败。

Created
RequestIdstring

请求 ID。

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

服务实例 ID。

si-d6ab3a63ccbb4b17****
MarketInstanceIdstring

云市场实例 ID。

786***45
OrderIdstring

订单 ID。

2306175xxxxxxxx

示例

正常返回示例

JSON格式

{
  "Status": "Created",
  "RequestId": "4DB0F536-B3BE-4F0D-BD29-E83FB56D****",
  "ServiceInstanceId": "si-d6ab3a63ccbb4b17****",
  "MarketInstanceId": "786***45",
  "OrderId": "2306175xxxxxxxx"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-02-23OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:AutoPay
出参OpenAPI 返回结构发生变更
2024-02-02OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:BusinessInfo
2024-02-01OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:BusinessInfo
2023-06-06OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:PayType
2023-03-24OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Commodity
出参OpenAPI 返回结构发生变更
2022-07-21OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Tag
2021-09-22OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:RequestTags
  • 本页导读 (0)
文档反馈