Query the basic information about a created EIP - Resource Orchestration Service

DATASOURCE::EIP::Address is used to query the information about a created elastic IP address (EIP).

Syntax

{
  "Type": "DATASOURCE::EIP::Address",
  "Properties": {
    "AllocationId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

AllocationId

String

Yes

The EIP ID.

None.

RefreshOptions

String

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

Description: the description of the EIP.
ResourceGroupId: the ID of the resource group.
ServiceManaged: indicates whether the resource is created by the service account.
AllocationId: the EIP ID.
SecondLimited: indicates whether level-2 throttling is configured.
BusinessStatus: the business status of the EIP.
ReservationOrderType: the type of the renewal order.
SegmentInstanceId: the ID of the contiguous EIP group.
InstanceRegionId: the region ID of the resource that is associated with the EIP.
ExpiredTime: the expiration time.
Bandwidth: the peak bandwidth of the EIP.
BandwidthPackageId: the ID of the Internet Shared Bandwidth instance that is associated with the EIP.
PaymentType: the billing method of the EIP.
InstanceType: the type of the instance that is associated with the EIP.
ReservationActiveTime: the time when the renewal takes effect.
ReservationBandwidth: the bandwidth when the renewal takes effect.
Tags: the tags of the EIP.
InstanceId: the ID of the instance that is associated with the EIP.
Isp: the line type.
CreateTime: the time when the EIP was created.
HasReservationData: indicates whether renewal data is included.
PublicIpAddressPoolId: the ID of the IP address pool to which the EIP belongs.
DeletionProtection: indicates whether deletion protection is enabled.
BandwidthPackageType: the bandwidth type.
OperationLocks: details of the locked EIP.
BandwidthPackageBandwidth: the bandwidth of the Internet Shared Bandwidth instance that is associated with the EIP.
ReservationInternetChargeType: the metering method when the renewal takes effect.
AddressName: the EIP name.
EipBandwidth: the bandwidth of the EIP after the EIP is associated with or disassociated from the Internet Shared Bandwidth instance.
Netmode: the network type.
SecurityProtectionTypes: the editions of Anti-DDoS.
IpAddress: the IP address of the EIP.
HdMonitorStatus: indicates whether fine-grained monitoring is enabled for the EIP.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AllocationId:
    Description:
      en: The ID of the EIP instance.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      AllocationId:
        Ref: AllocationId
    Type: DATASOURCE::EIP::Address
Outputs:
  AddressName:
    Description: The name of the EIP.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AddressName
  AllocationId:
    Description: The ID of the EIP instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AllocationId
  Bandwidth:
    Description: 'The peak bandwidth of the EIP. Unit: Mbps.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Bandwidth
  BandwidthPackageBandwidth:
    Description: The bandwidth value of the Internet shared bandwidth added to the
      EIP. The unit is Mbps.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BandwidthPackageBandwidth
  BandwidthPackageId:
    Description: The ID of the added shared bandwidth.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BandwidthPackageId
  BandwidthPackageType:
    Description: The type of bandwidth. Only **CommonBandwidthPackage** (shared bandwidth)
      is supported.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BandwidthPackageType
  BusinessStatus:
    Description: The business status of the EIP instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - BusinessStatus
  CreateTime:
    Description: The time when the EIP was created.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  DeletionProtection:
    Description: Whether the delete protection function is turned on.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DeletionProtection
  Description:
    Description: The description of the EIP instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Description
  EipBandwidth:
    Description: AN EIP is added to an Internet shared bandwidth before or exit purchase
      an Internet shared bandwidth instance after the bandwidth Mbps Set for the bandwidth.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EipBandwidth
  ExpiredTime:
    Description: Expiration time, format' YYYY-MM-DDThh:mm:ssZ '.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ExpiredTime
  HasReservationData:
    Description: Whether there is renewal data.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - HasReservationData
  HdMonitorStatus:
    Description: Whether the second-level monitoring is enabled for the EIP.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - HdMonitorStatus
  InstanceId:
    Description: The ID of the current bound instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceId
  InstanceRegionId:
    Description: The region ID of the currently bound resource.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceRegionId
  InstanceType:
    Description: The type of the current bound instance.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceType
  IpAddress:
    Description: The IP address of the EIP.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - IpAddress
  Isp:
    Description: Service providers.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Isp
  Netmode:
    Description: Network type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Netmode
  OperationLocks:
    Description: Lock details.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - OperationLocks
  PaymentType:
    Description: The billing method of the EIP.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PaymentType
  PublicIpAddressPoolId:
    Description: The ID of the IP address pool to which the EIP belongs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PublicIpAddressPoolId
  ReservationActiveTime:
    Description: The effective time of the renewal fee, in the format of 'YYYY-MM-DDThh:mm:ssZ'.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ReservationActiveTime
  ReservationBandwidth:
    Description: Renewal bandwidth, in Mbps.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ReservationBandwidth
  ReservationInternetChargeType:
    Description: Renewal Payment type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ReservationInternetChargeType
  ReservationOrderType:
    Description: Renewal order type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ReservationOrderType
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ResourceGroupId
  SecondLimited:
    Description: Whether a secondary speed limit is configured.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SecondLimited
  SecurityProtectionTypes:
    Description: Security protection level.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SecurityProtectionTypes
  SegmentInstanceId:
    Description: The ID of the consecutive EIPs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SegmentInstanceId
  ServiceManaged:
    Description: Indicates the resource created for the service account.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ServiceManaged
  Tags:
    Description: The tag of the resource.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Tags

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AllocationId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the EIP instance."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::EIP::Address",
      "Properties": {
        "AllocationId": {
          "Ref": "AllocationId"
        }
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "The description of the EIP instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "ServiceManaged": {
      "Description": "Indicates the resource created for the service account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceManaged"
        ]
      }
    },
    "AllocationId": {
      "Description": "The ID of the EIP instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AllocationId"
        ]
      }
    },
    "SecondLimited": {
      "Description": "Whether a secondary speed limit is configured.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecondLimited"
        ]
      }
    },
    "BusinessStatus": {
      "Description": "The business status of the EIP instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BusinessStatus"
        ]
      }
    },
    "ReservationOrderType": {
      "Description": "Renewal order type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationOrderType"
        ]
      }
    },
    "SegmentInstanceId": {
      "Description": "The ID of the consecutive EIPs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SegmentInstanceId"
        ]
      }
    },
    "InstanceRegionId": {
      "Description": "The region ID of the currently bound resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceRegionId"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "Expiration time, format' YYYY-MM-DDThh:mm:ssZ '.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpiredTime"
        ]
      }
    },
    "Bandwidth": {
      "Description": "The peak bandwidth of the EIP. Unit: Mbps.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Bandwidth"
        ]
      }
    },
    "BandwidthPackageId": {
      "Description": "The ID of the added shared bandwidth.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BandwidthPackageId"
        ]
      }
    },
    "PaymentType": {
      "Description": "The billing method of the EIP.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "InstanceType": {
      "Description": "The type of the current bound instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceType"
        ]
      }
    },
    "ReservationActiveTime": {
      "Description": "The effective time of the renewal fee, in the format of 'YYYY-MM-DDThh:mm:ssZ'.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationActiveTime"
        ]
      }
    },
    "ReservationBandwidth": {
      "Description": "Renewal bandwidth, in Mbps.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationBandwidth"
        ]
      }
    },
    "Tags": {
      "Description": "The tag of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "InstanceId": {
      "Description": "The ID of the current bound instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceId"
        ]
      }
    },
    "Isp": {
      "Description": "Service providers.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Isp"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the EIP was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "HasReservationData": {
      "Description": "Whether there is renewal data.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HasReservationData"
        ]
      }
    },
    "PublicIpAddressPoolId": {
      "Description": "The ID of the IP address pool to which the EIP belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddressPoolId"
        ]
      }
    },
    "DeletionProtection": {
      "Description": "Whether the delete protection function is turned on.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeletionProtection"
        ]
      }
    },
    "BandwidthPackageType": {
      "Description": "The type of bandwidth. Only **CommonBandwidthPackage** (shared bandwidth) is supported.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BandwidthPackageType"
        ]
      }
    },
    "OperationLocks": {
      "Description": "Lock details.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "OperationLocks"
        ]
      }
    },
    "BandwidthPackageBandwidth": {
      "Description": "The bandwidth value of the Internet shared bandwidth added to the EIP. The unit is Mbps.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BandwidthPackageBandwidth"
        ]
      }
    },
    "ReservationInternetChargeType": {
      "Description": "Renewal Payment type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationInternetChargeType"
        ]
      }
    },
    "AddressName": {
      "Description": "The name of the EIP.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AddressName"
        ]
      }
    },
    "EipBandwidth": {
      "Description": "AN EIP is added to an Internet shared bandwidth before or exit purchase an Internet shared bandwidth instance after the bandwidth Mbps Set for the bandwidth.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EipBandwidth"
        ]
      }
    },
    "Netmode": {
      "Description": "Network type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Netmode"
        ]
      }
    },
    "SecurityProtectionTypes": {
      "Description": "Security protection level.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityProtectionTypes"
        ]
      }
    },
    "IpAddress": {
      "Description": "The IP address of the EIP.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IpAddress"
        ]
      }
    },
    "HdMonitorStatus": {
      "Description": "Whether the second-level monitoring is enabled for the EIP.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HdMonitorStatus"
        ]
      }
    }
  }
}