All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::ApiGateway::Instance

更新時間:Nov 01, 2024

DATASOURCE::ApiGateway::Instance is used to query the information about an instance.

Syntax

{
  "Type": "DATASOURCE::ApiGateway::Instance",
  "Properties": {
    "InstanceId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

InstanceId

String

Yes

Yes

The instance ID.

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

  • ClassicEgressAddress: the outbound IP address of the classic network.

  • InstanceSpec: the instance type.

  • HttpsPolicy: the HTTPS policy.

  • InternetEgressAddress: the outbound IP address of the Internet.

  • ZoneLocalName: the zone.

  • InstanceSpecAttributes: the instance specifications.

  • InstanceRpsLimit: the records per second (RPS) limit on the instance.

  • VpcSlbIntranetEnable: indicates whether a Server Load Balancer (SLB) instance that can be accessed over a virtual private cloud (VPC) is enabled.

  • ExpiredTime: the expiration time of the instance.

  • UserVpcId: the VPC ID.

  • PaymentType: the billing method of the instance.

  • InstanceType: the category of the instance.

  • UserVswitchId: the vSwitch ID.

  • VpcEgressAddress: the outbound IP address of the VPC.

  • ZoneId: the zone ID.

  • InstanceId: the instance ID.

  • AclId: the ID of the access control list (ACL).

  • CreateTime: the creation time of the instance.

  • VpcOwnerId: the ID of the account to which the VPC belongs.

  • AclName: the ACL name.

  • InstanceName: the instance name.

  • EgressIpv6Enable: indicates whether outbound IPv6 traffic is supported.

  • AclStatus: indicates whether the ACL feature is enabled.

  • VpcIntranetEnable: indicates whether the VPC feature is enabled.

  • AclType: the ACL type.

  • SupportIpv6: indicates whether the instance supports IPv6.

  • VipTypeList: the type of the virtual IP address (VIP).

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Description:
      en: Instance id.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      InstanceId:
        Ref: InstanceId
    Type: DATASOURCE::ApiGateway::Instance
Outputs:
  AclId:
    Description: Access control ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AclId
  AclName:
    Description: Access control name.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AclName
  AclStatus:
    Description: Access control type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AclStatus
  AclType:
    Description: Access control type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AclType
  ClassicEgressAddress:
    Description: Classic network exit address.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ClassicEgressAddress
  CreateTime:
    Description: Creation time.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  EgressIpv6Enable:
    Description: Does IPV6 Capability Support.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EgressIpv6Enable
  ExpiredTime:
    Description: Instance expiration time.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ExpiredTime
  HttpsPolicy:
    Description: Https policy.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - HttpsPolicy
  InstanceId:
    Description: Instance id.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceId
  InstanceName:
    Description: Instance name.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceName
  InstanceRpsLimit:
    Description: Instance rps limits.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceRpsLimit
  InstanceSpec:
    Description: Instance type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceSpec
  InstanceSpecAttributes:
    Description: Instance type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceSpecAttributes
  InstanceType:
    Description: Instance type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceType
  InternetEgressAddress:
    Description: Public network exit address.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InternetEgressAddress
  PaymentType:
    Description: The payment type of the resource.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PaymentType
  SupportIpv6:
    Description: Does ipv6 support.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SupportIpv6
  UserVpcId:
    Description: User's VpcID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - UserVpcId
  UserVswitchId:
    Description: DescribeInstances.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - UserVswitchId
  VipTypeList:
    Description: Vip type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VipTypeList
  VpcEgressAddress:
    Description: Intranet VPC exit network segment.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcEgressAddress
  VpcIntranetEnable:
    Description: Whether Vpc allows authorization.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcIntranetEnable
  VpcOwnerId:
    Description: Vpc licensor ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcOwnerId
  VpcSlbIntranetEnable:
    Description: Whether the slb of the Vpc supports.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcSlbIntranetEnable
  ZoneId:
    Description: Zone.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ZoneId
  ZoneLocalName:
    Description: Available area.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ZoneLocalName
                        

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "Instance id."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Instance",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "ClassicEgressAddress": {
      "Description": "Classic network exit address.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ClassicEgressAddress"
        ]
      }
    },
    "InstanceSpec": {
      "Description": "Instance type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceSpec"
        ]
      }
    },
    "HttpsPolicy": {
      "Description": "Https policy.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HttpsPolicy"
        ]
      }
    },
    "InternetEgressAddress": {
      "Description": "Public network exit address.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InternetEgressAddress"
        ]
      }
    },
    "ZoneLocalName": {
      "Description": "Available area.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneLocalName"
        ]
      }
    },
    "InstanceSpecAttributes": {
      "Description": "Instance type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceSpecAttributes"
        ]
      }
    },
    "InstanceRpsLimit": {
      "Description": "Instance rps limits.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceRpsLimit"
        ]
      }
    },
    "VpcSlbIntranetEnable": {
      "Description": "Whether the slb of the Vpc supports.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcSlbIntranetEnable"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "Instance expiration time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpiredTime"
        ]
      }
    },
    "UserVpcId": {
      "Description": "User's VpcID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UserVpcId"
        ]
      }
    },
    "PaymentType": {
      "Description": "The payment type of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "InstanceType": {
      "Description": "Instance type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceType"
        ]
      }
    },
    "UserVswitchId": {
      "Description": "DescribeInstances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UserVswitchId"
        ]
      }
    },
    "VpcEgressAddress": {
      "Description": "Intranet VPC exit network segment.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcEgressAddress"
        ]
      }
    },
    "ZoneId": {
      "Description": "Zone.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "InstanceId": {
      "Description": "Instance id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceId"
        ]
      }
    },
    "AclId": {
      "Description": "Access control ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AclId"
        ]
      }
    },
    "CreateTime": {
      "Description": "Creation time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "VpcOwnerId": {
      "Description": "Vpc licensor ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcOwnerId"
        ]
      }
    },
    "AclName": {
      "Description": "Access control name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AclName"
        ]
      }
    },
    "InstanceName": {
      "Description": "Instance name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceName"
        ]
      }
    },
    "EgressIpv6Enable": {
      "Description": "Does IPV6 Capability Support.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EgressIpv6Enable"
        ]
      }
    },
    "AclStatus": {
      "Description": "Access control type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AclStatus"
        ]
      }
    },
    "VpcIntranetEnable": {
      "Description": "Whether Vpc allows authorization.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcIntranetEnable"
        ]
      }
    },
    "AclType": {
      "Description": "Access control type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AclType"
        ]
      }
    },
    "SupportIpv6": {
      "Description": "Does ipv6 support.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SupportIpv6"
        ]
      }
    },
    "VipTypeList": {
      "Description": "Vip type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VipTypeList"
        ]
      }
    }
  }
}