DATASOURCE::ApiGateway::Instances is used to query instances.

Syntax

{
  "Type": "DATASOURCE::ApiGateway::Instances",
  "Properties": {
    "Language": String,
    "InstanceId": String
  }
}

Properties

Property Type Required Editable Description Constraint
Language String No Yes The type of the language. Valid values:
  • en: English
  • zh: Chinese
  • ja: Japanese
InstanceId String No Yes The ID of the instance that you want to query. None.

Return values (Fn::GetAtt)

  • ApiGatewayInstances: details of the instances.
  • ApiGatewayInstanceIds: the IDs of the instances.
Property Type Description Constraint
ApiGatewayInstanceIds List The IDs of the instances. None.
ApiGatewayInstances List Details of the instances. None.
Status String The status of the instance. None.
InstanceId String The ID of the instance. None.
VpcSlbIntranetEnable Boolean Indicates whether Server Load Balancer (SLB) instances of the virtual private cloud (VPC) type are supported. Valid values:
  • true
  • false
ClassicEgressAddress String The outbound rule of the classic network. None.
ZoneLocalName String The name of the zone. None.
VipTypeList String The type of the Elastic IP Address (EIP). None.
UserVpcId String The ID of the VPC in which the instance is deployed. None.
VpcIntranetEnable Boolean Indicates whether Internet access is enabled. Valid values:
  • true
  • false
VpcOwnerId String The ID of the Alibaba Cloud account to which the VPC belongs. None.
InstanceRpsLimit Integer The records per second (RPS) limit on the instance. None.
InstanceType String The category of the instance. Valid values:
  • VPC_SHARED: shared instance
  • VPC_DEDICATED: dedicated instance
RegionId String The ID of the region. None.
InstanceSpec String The specification of the instance. None.
InstanceChargeType String The billing method of the instance. Valid values:
  • PrePaid: subscription
  • PayAsYouGo: pay-as-you-go
HttpsPolicies String The HTTPS security policy. None.
VpcEgressAddress String The outbound IP address in the VPC. None.
EgressIpv6Enable Boolean Indicates whether outbound IPv6 traffic is supported. Valid values:
  • true
  • false
ExpiredTime String The time when the instance expires. The time is displayed in UTC.
InstanceName String The name of the instance. None.
ZoneId String The ID of the zone. None.
SupportIpv6 Boolean Indicates whether IPv6 is supported. Valid values:
  • true
  • false
InternetEgressAddress String The outbound public IP address. None.
CreatedTime String The time when the instance was created. The time is displayed in UTC.
UserVswitchId String The ID of the vSwitch. None.
InstanceSpecAttributes List The specification attributes of the instance. None.

Examples

  • JSON format 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": "API Gateway Instance ID."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Instances",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "ApiGatewayInstances": {
      "Description": "The information about ApiGateway groups.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGatewayInstances"
        ]
      }
    },
    "ApiGatewayInstanceIds": {
      "Description": "The list of The ApiGateway group ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGatewayInstanceIds"
        ]
      }
    }
  }
}

  • YAML format 

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description: API Gateway Instance ID.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ApiGateway::Instances
    Properties:
      InstanceId:
        Ref: InstanceId
Outputs:
  ApiGatewayInstances:
    Description: The information about ApiGateway groups.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGatewayInstances
  ApiGatewayInstanceIds:
    Description: The list of The ApiGateway group ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGatewayInstanceIds