创建并部署服务实例_资源编排(ROS)-阿里云帮助中心

ALIYUN::ComputeNest::ServiceInstance类型用于创建并部署服务实例。

语法

{
  "Type": "ALIYUN::ComputeNest::ServiceInstance",
  "Properties": {
    "SpecificationCode": String,
    "Parameters": Map,
    "ResourceGroupId": String,
    "OperationName": String,
    "EnableInstanceOps": Boolean,
    "Service": Map,
    "PredefinedParameterName": String,
    "Name": String,
    "Commodity": Map,
    "EnableUserPrometheus": Boolean,
    "TemplateName": String,
    "MarketInstanceId": String,
    "ContactGroup": String,
    "Tags": List
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
SpecificationCode	String	否	否	商品规格码。	无
Parameters	Map	否	否	用户实例部署的参数。	例如： `{"NodeCount": 3, "SystemDiskSize": 40, "InstancePassword": "******"}`
ResourceGroupId	String	否	是	资源组ID。	无
OperationName	String	否	否	操作名称。	无
EnableInstanceOps	Boolean	否	否	服务实例是否有代运维功能。	取值： true：服务实例有代运维功能。 false：服务实例没有代运维功能。
Service	Map	是	否	服务详情。	更多信息，请参见Service属性。
PredefinedParameterName	String	否	否	套餐名称。	无
Name	String	否	否	服务名称。	无
Commodity	Map	否	否	云市场购买订单信息，服务未上云市场或按量计费不必传。	更多信息，请参见Commodity属性
EnableUserPrometheus	Boolean	否	否	是否启用Prometheus监控。	取值： true：启用。 false：不启用。
TemplateName	String	否	否	模板名称。	服务支持多模板时需要指定模板名称。
MarketInstanceId	String	否	否	云市场实例ID。	无
ContactGroup	String	否	否	接收告警的云监控联系人组。	无
Tags	List	否	是	用户自定义标签。	`{'Length': {'Max': 20}}`

Service语法

"Service": {
  "Version": String,
  "ServiceId": String
}

Service属性

属性名称	类型	必须	允许更新	描述	约束
Version	String	否	否	服务版本。	无
ServiceId	String	是	否	服务ID。	无

Commodity语法

"Commodity": {
  "PayPeriod": Integer,
  "PayPeriodUnit": String
}

Commodity属性

属性名称

类型

必须

允许更新

描述

约束

PayPeriod

Integer

否

购买时间长度。

无

PayPeriodUnit

String

否

购买时间单位。

取值：

Year：年。
Month：月。
Day：日。

Tags语法

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags属性

属性名称	类型	必须	允许更新	描述	约束
Value	String	否	否	标签值。	长度为0~128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或`https://`。
Key	String	是	否	标签键。	长度为1~128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或`https://`。

返回值

Fn::GetAtt

Progress：服务实例的部署进度。
Parameters：部署服务实例输入的参数。
ResourceGroupId：资源组ID。
EnableInstanceOps：服务实例是否有代运维功能。
CreateTime：创建时间。
NetworkConfig：网络配置信息。
Service：服务详情。
PredefinedParameterName：套餐名称。
Source：服务实例来源。
Name：服务实例名称。
Components：云市场额外计费项。
LicenseEndTime：许可到期时间。
ServiceInstanceId：服务实例ID。
UserId：用户的AliUid。
EnableUserPrometheus：是否启用Prometheus监控。
ServiceType：服务类型。
StatusDetail：部署实例的状态描述。
UpdateTime：更新时间。
Outputs：创建服务实例返回的输出字段。
TemplateName：模板名称。
IsOperated：服务实例的代运维功能是否开启。
SupplierUid：服务商AliUid。
Tags：用户自定义标签。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Parameters:
    Type: Json
    Description: The parameters entered by the deployment service instance.
    Default:
      NodeCount: 3
      SystemDiskSize: 40
      InstancePassword: '******'
  Service:
    Type: Json
    Description: Service details.
    Default:
      Version: 1
      ServiceId: service-9c8a3522528b4fe8****
  Name:
    Type: String
    Description: The name of the service instance.
    Default: test
Resources:
  ExtensionResource:
    Type: ALIYUN::ComputeNest::ServiceInstance
    Properties:
      Parameters:
        Ref: Parameters
      Service:
        Ref: Service
      Name:
        Ref: Name
Outputs:
  Progress:
    Description: The deployment progress of the service instance. Unit:%.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Progress
  Parameters:
    Description: The parameters entered by the deployment service instance.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Parameters

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Parameters": {
      "Type": "Json",
      "Description": "The parameters entered by the deployment service instance.",
      "Default": {
        "NodeCount": 3,
        "SystemDiskSize": 40,
        "InstancePassword": "******"
      }
    },
    "Service": {
      "Type": "Json",
      "Description": "Service details.",
      "Default": {
        "Version": 1,
        "ServiceId": "service-9c8a3522528b4fe8****"
      }
    },
    "Name": {
      "Type": "String",
      "Description": "The name of the service instance.",
      "Default": "test"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ComputeNest::ServiceInstance",
      "Properties": {
        "Parameters": {
          "Ref": "Parameters"
        },
        "Service": {
          "Ref": "Service"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "Progress": {
      "Description": "The deployment progress of the service instance. Unit:%.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Progress"
        ]
      }
    },
    "Parameters": {
      "Description": "The parameters entered by the deployment service instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Parameters"
        ]
      }
    }
  }
}