Use DATASOURCE::MSE::Gateways to query gateways - Resource Orchestration Service

DATASOURCE::MSE::Gateways is used to query the information about gateways.

Syntax

{
  "Type": "DATASOURCE::MSE::Gateways",
  "Properties": {
    "InstanceId": String,
    "Vpc": String,
    "GatewayType": String,
    "GatewayId": String,
    "Name": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
InstanceId	String	No	Yes	The instance ID.	None.
Vpc	String	No	Yes	The virtual private cloud (VPC).	None.
GatewayType	String	No	Yes	The gateway type.	None.
GatewayId	String	No	Yes	The gateway ID.	None.
Name	String	No	Yes	The gateway name.	None.
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): does not refresh data source resources when the stack is updated. Always: refreshes data source resources when the stack is updated.

Return values (Fn::GetAtt)

GatewayIds: the IDs of the gateways.
Gateways: details of the gateways.

Property	Type	Description	Constraint
GatewayIds	List	The IDs of the gateways.	None.
Gateways	List	Details of the gateways.	None.
GatewayId	String	The gateway ID.	None.
GmtModified	String	The modification time.	The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
Slb	Map	The information about Server Load Balancer (SLB).	None.
GatewayType	String	The gateway type.	None.
Upgrade	Boolean	Indicates whether the gateway can be upgraded.	None.
Name	String	The gateway name.	None.
AppVersion	String	The version of the application.	None.
StatusDesc	String	The description of the status.	None.
ArmsOn	Boolean	Indicates whether Application Real-Time Monitoring Service (ARMS) is activated.	Valid values: true false
InternetSlb	Map	The information about Internet-facing SLB instances.	None.
Status	String	The status of the gateway.	Valid values: 0: The gateway is being created. 1: The gateway failed to be created. 2: The gateway is running. 3: The gateway is being changed. 4: The gateway is being scaled down or in. 6: The gateway is being scaled up or out. 8: The gateway is being deleted. 9: The gateway is pending to be released. 10: The gateway is being restarted. 11: The gateway is being recreated. 12: The gateway is being upgraded. 13: The gateway failed to be upgraded.
SupportWasm	Boolean	Indicates whether WebAssembly (Wasm) is supported.	Valid values: true false
MustUpgrade	Boolean	Indicates whether the gateway can be forcefully upgraded.	None.
InstanceId	String	The instance ID.	None.
AhasOn	Boolean	Indicates whether Application High Availability Service is activated.	Valid values: true false
GmtCreate	String	The time when the gateway was created.	The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
ChargeType	String	The billing method.	Valid values: Postpaid: pay-as-you-go Prepaid: subscription
Region	String	The region.	None.
PrimaryUser	String	The information about the Alibaba Cloud user.	None.
InitConfig	Map	The configurations.	None.
Id	String	The instance ID.	None.
Spec	String	The specification.	None.

Examples

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": "The instance ID of gateway."
    }
  },
  "Resources": {
    "Gateways": {
      "Type": "DATASOURCE::MSE::Gateways",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "Gateways": {
      "Description": "The list of gateways.",
      "Value": {
        "Fn::GetAtt": [
          "Gateways",
          "Gateways"
        ]
      }
    },
    "GatewayIds": {
      "Description": "The list of gateway IDs.",
      "Value": {
        "Fn::GetAtt": [
          "Gateways",
          "GatewayIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description: The instance ID of gateway.
Resources:
  Gateways:
    Type: DATASOURCE::MSE::Gateways
    Properties:
      InstanceId:
        Ref: InstanceId
Outputs:
  Gateways:
    Description: The list of gateways.
    Value:
      Fn::GetAtt:
        - Gateways
        - Gateways
  GatewayIds:
    Description: The list of gateway IDs.
    Value:
      Fn::GetAtt:
        - Gateways
        - GatewayIds