ALIYUN::ComputeNest::ServiceInstance資源類型的文法屬性與傳回值-Resource Orchestration Service-阿里雲

ALIYUN::ComputeNest::ServiceInstance類型用於建立並部署服務執行個體。

文法

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

屬性

屬性名稱	類型	必須	允許更新	描述	約束
Service	Map	是	否	服務詳情。	更多資訊，請參見Service屬性
Commodity	Map	否	否	雲市場購買訂單資訊，服務未上雲市場或隨用隨付不必傳。	更多資訊，請參見Commodity屬性
ContactGroup	String	否	否	接收警示的CloudMonitor連絡人群組。	無
EnableInstanceOps	Boolean	否	否	服務執行個體是否有代營運功能。	取值： true：服務執行個體有代營運功能。 false：服務執行個體沒有代營運功能。
EnableUserPrometheus	Boolean	否	是	是否啟用Prometheus監控。	取值： true：啟用。 false：不啟用。
OperationName	String	否	否	操作名稱。	無
Parameters	Map	否	是	使用者執行個體部署的參數。	例如： `{"NodeCount": 3, "SystemDiskSize": 40, "InstancePassword": "******"}`
PredefinedParameterName	String	否	是	套餐名稱。	無
ResourceGroupId	String	否	是	資源群組ID。	無
SpecificationCode	String	否	否	商品規格碼。	無
Tags	List	否	否	使用者自訂標籤。	`{'Length': {'Max': 20}}`
TemplateName	String	否	否	模板名稱。	服務支援多模板時需要指定模板名稱。
ServiceInstanceName	String	否	否	服務執行個體名稱。	無
ResourceAutoPay	Boolean	否	否	資源是否自動從餘額中扣款支付。	取值： true：自動支付。 false：不自動支付。
DryRun	Boolean	否	否	是否對此次建立請求執行預檢。	包括許可權、執行個體狀態校正等。可能的值： true：發送請求，不建立服務執行個體。 false：發送請求，檢查通過後建立服務執行個體。

Service文法

"Service": {
  "ServiceInfos": List,
  "ServiceDocUrl": String,
  "DeployType": String,
  "ServiceProductUrl": String,
  "ServiceType": String,
  "SupplierUrl": String,
  "Status": String,
  "SupplierName": String,
  "PublishTime": String,
  "UpgradableServiceVersions": List,
  "DeployMetadata": String,
  "VersionName": String,
  "UpgradeMetadata": String,
  "Version": String,
  "ServiceId": String
}

Service屬性

屬性名稱	類型	必須	允許更新	描述	約束
ServiceInfos	List	否	否	服務資訊。	更多資訊，請參考ServiceInfos屬性。
ServiceDocUrl	String	否	否	產品文檔的 URL。	無
DeployType	String	否	否	部署類型。	可能值： ros：通過 ROS 部署。 terraform：通過 Terraform 部署。 ack：通過 ACK 部署。 spi：調用 SPI 部署。 operation：代營運服務部署。
Version	String	否	否	服務商版本。	無
ServiceId	String	是	否	服務ID。	無
ServiceProductUrl	String	否	否	產品頁 URL。	無
ServiceType	String	否	否	服務類型。	可能值： private：部署在使用者賬戶下。 managed：託管在服務商賬戶下。 operation：代營運服務。
SupplierUrl	String	否	否	服務商地址。	無
Status	String	否	否	服務執行個體的部署狀態。	可能值： Created：已建立。 Deploying：部署中。 DeployedFailed：部署失敗。 Deployed：已部署。 Upgrading：升級中。 Deleting：刪除中。 Deleted：已刪除。 DeletedFailed：刪除失敗。
SupplierName	String	否	否	服務商名稱。	無
PublishTime	String	否	否	發布時間。	無
UpgradableServiceVersions	List	否	否	可升級的服務版本列表。	無
DeployMetadata	String	否	否	儲存服務部署組態的資訊。	無
VersionName	String	否	否	服務商自訂版本名稱。	無
UpgradeMetadata	String	否	否	升級中繼資料。	無

ServiceInfos文法

"ServiceInfos": [
  {
    "Image": String,
    "Locale": String,
    "Name": String,
    "ShortDescription": String
  }
]

ServiceInfos屬性

屬性名稱	類型	必須	允許更新	描述	約束
Image	String	否	否	服務表徵圖地址。	無
Locale	String	否	否	服務執行個體語言。	無
Name	String	否	否	服務名稱。	無
ShortDescription	String	否	否	服務概述。	無

Commodity文法

"Commodity": {
  "PayPeriod": Integer,
  "PayPeriodUnit": String,
  "AutoRenew": Boolean,
  "CouponId": String,
  "AutoPay": Boolean
}

Commodity屬性

屬性名稱	類型	必須	允許更新	描述	約束
PayPeriod	Integer	否	否	購買時間長度。	無
PayPeriodUnit	String	否	否	購買時間單位。	取值： Year：年。 Month：月。 Day：日。
AutoRenew	Boolean	否	否	是否開啟自動續約	取值： true：開啟。 false：不開啟。
CouponId	String	否	否	優惠券 ID。	無
AutoPay	Boolean	否	否	訂單是否自動支付。	取值： true：自動支付。 false：不自動支付。

Tags文法

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

Tags屬性

屬性名稱	類型	必須	允許更新	描述	約束
Key	String	是	否	標籤鍵。	長度為1~128個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或`https://`。
Value	String	否	否	標籤值。	長度為0~128個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或`https://`。

傳回值

Fn::GetAtt

Progress：服務執行個體的部署進度。

Parameters：部署服務執行個體輸入的參數。

ResourceGroupId：資源群組ID。

EnableInstanceOps：服務執行個體是否有代營運功能。

CreateTime：建立時間。

NetworkConfig：網路設定資訊。

Service：服務詳情。

PredefinedParameterName：套餐名稱。

Source：服務執行個體來源。

Components：雲市場額外計費項目。

LicenseEndTime：許可到期時間。

ServiceInstanceId：服務執行個體ID。

UserId：使用者的AliUid。

EnableUserPrometheus：是否啟用Prometheus監控。

ServiceType：服務類型。

StatusDetail：部署執行個體的狀態原因。

UpdateTime：更新時間。

Outputs：建立服務執行個體返回的輸出欄位。

TemplateName：模板名稱。

IsOperated：服務執行個體的代營運功能是否開啟。

SupplierUid：服務商AliUid。

Tags：使用者自訂標籤。

Output：建立服務執行個體返回的輸出欄位。

ServiceInstanceName：服務執行個體名稱。

MarketInstanceId：雲市場執行個體 ID。

樣本

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****
Resources:
  ExtensionResource:
    Type: ALIYUN::ComputeNest::ServiceInstance
    Properties:
      Parameters:
        Ref: Parameters
      Service:
        Ref: Service
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****"
      }
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ComputeNest::ServiceInstance",
      "Properties": {
        "Parameters": {
          "Ref": "Parameters"
        },
        "Service": {
          "Ref": "Service"
        }
      }
    }
  },
  "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"
        ]
      }
    }
  }
}