DATASOURCE::MSE::Gateways is used to query gateways.

Syntax

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

Properties

Property Type Required Editable Description Constraint
InstanceId String No Yes The ID of the instance. None
Vpc String No Yes The ID of the virtual private cloud (VPC). None
GatewayType String No Yes The type of the gateway. None
GatewayId String No Yes The ID of the gateway. None
Name String No Yes The name of the gateway. None

Response parameters (Fn::GetAtt)

  • GatewayIds: the IDs of the gateways.
  • Gateways: the details of the gateways.
Parameter Type Description Constraint
GatewayIds List The IDs of the gateways. None.
Gateways List The details of the gateways. None.
GatewayId String The ID of the gateway. None.
GmtModified String The time when the gateway was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in Coordinated Universal Time (UTC).
Slb Map The details of the Server Load Balancer (SLB) instances. None.
GatewayType String The type of the gateway. None.
Upgrade Boolean Indicates whether the gateway can be updated. None.
Name String The name of the gateway. None.
AppVersion String The version of the application. None.
StatusDesc String The description of the state. None.
ArmsOn Boolean Indicates whether Application Real-Time Monitoring Service (ARMS) is enabled. Valid values:
  • true
  • false
InternetSlb Map The details of the Internet-facing SLB instances. None.
Status String The state of the gateway. Valid values:
  • 0: The gateway is being created.
  • 1: The gateway fails to be created.
  • 2: The gateway is running.
  • 3: The gateway status is being changed.
  • 4: The gateway is being scaled down.
  • 6: The gateway is being scaled up.
  • 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 updated.
  • 13: The gateway fails to be upgraded.
SupportWasm Boolean Indicates whether WebAssembly (Wasm) is supported. Valid values:
  • true
  • false
MustUpgrade Boolean Indicates whether the gateway can be forcefully updated. None.
InstanceId String The ID of the instance. None.
AhasOn Boolean Indicates whether Application High Availability Service (AHAS) is enabled. 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 of the gateway. Valid values:
  • Postpaid: pay-as-you-go
  • Prepaid: subscription
Region String The ID of the region. None.
PrimaryUser String The information about the Alibaba Cloud account. None.
InitConfig Map The configurations of the gateway. None.
Id String The ID of the gateway. None.
Spec String The specifications of the gateway. None.

Examples

  • JSON format 

    {
  "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 format 

    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