How to use DATASOURCE::EIP::Addresses to query information about EIPs - Resource Orchestration Service

DATASOURCE::EIP::Addresses is used to query the information about elastic IP addresses (EIPs).

Syntax

{
  "Type": "DATASOURCE::EIP::Addresses",
  "Properties": {
    "SegmentInstanceId": String,
    "AddressName": String,
    "ResourceGroupId": String,
    "InstanceId": String,
    "Isp": String,
    "AllocationId": String,
    "PaymentType": String,
    "IpAddress": String,
    "InstanceType": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
SegmentInstanceId	String	No	Yes	The ID of the contiguous EIP.	None.
AddressName	String	No	Yes	The EIP name.	The name must be 1 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter.
ResourceGroupId	String	No	Yes	The ID of the resource group.	None.
InstanceId	String	No	Yes	The ID of the instance that is associated with the EIP.	None.
Isp	String	No	Yes	The line type.	Valid values: BGP BGP_PRO RunShellScript ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2
AllocationId	String	No	Yes	The EIP ID.	None.
PaymentType	String	No	Yes	The billing method of the EIP.	Valid values: PostPaid PrePaid
IpAddress	String	No	Yes	The IP address of the EIP.	None.
InstanceType	String	No	Yes	The type of the instance that is associated with the EIP.	Valid values: IpAddress: IP address NetworkInterface: secondary elastic network interface (ENI) HaVip: high-availability virtual IP address (HAVIP) Nat: NAT gateway SlbInstance: Server Load Balancer (SLB) instance of the virtual private cloud (VPC) type EcsInstance: Elastic Compute Service (ECS) instance of the VPC type
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

Addresses: details of the EIPs.
AllocationIds: the IDs of the EIPs.

Property	Type	Description	Constraint
AllocationIds	List	The IDs of the EIPs.	None.
Addresses	List	Details of the EIPs.	None.
BusinessStatus	String	The service status of the EIP.	None.
ExpiredTime	String	The expiration time.	The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format.
IpAddress	String	The IP address of the EIP.	None.
AllocationId	String	The EIP ID.	None.
ReservationOrderType	String	The type of the renewal order.	None.
Status	String	The status of the EIP.	None.
EipBandwidth	String	The bandwidth of the EIP when it is not associated with an Internet Shared Bandwidth instance.	Unit: Mbit/s.
BandwidthPackageId	String	The ID of the Internet Shared Bandwidth instance with which the EIP is associated.	None.
Description	String	The description of the EIP.	None.
Tags	List	The tags of the EIP.	None.
InstanceId	String	The ID of the instance that is associated with the EIP.	None.
ReservationBandwidth	String	The bandwidth that is used after the renewal takes effect.	Unit: Mbit/s.
InstanceRegionId	String	The region ID of the associated resource.	None.
RegionId	String	The region ID of the EIP.	None.
SegmentInstanceId	String	The ID of the contiguous EIP.	None.
ResourceGroupId	String	The ID of the resource group.	None.
HasReservationData	String	Indicates whether renewal data is included.	None.
Netmode	String	The network type.	Only public may be returned, which indicates the Internet.
InstanceType	String	The type of the instance that is associated with the EIP.	None.
OperationLocks	List	Details of the locked EIP.	None.
ReservationInternetChargeType	String	The metering method that is used after the renewal takes effect.	None.
Isp	String	The line type.	None.
DeletionProtection	Boolean	Indicates whether deletion protection is enabled.	Valid values: true false
BandwidthPackageType	String	The bandwidth type.	Only CommonBandwidthPackage may be returned, which indicates an Internet Shared Bandwidth instance.
ServiceManaged	Integer	Indicates whether the EIP is created by using the service account.	Valid values: 0: The EIP is not created by using the service account. 1: The EIP is created by using the service account.
CreateTime	String	The time when the EIP was created.	Unit: milliseconds.
PaymentType	String	The billing method of the EIP.	None.
Bandwidth	String	The maximum bandwidth of the EIP.	Unit: Mbit/s.
HdMonitorStatus	String	Indicates whether fine-grained monitoring is enabled for the EIP.	Valid values: true false
ReservationActiveTime	String	The time when the renewal takes effect.	The time follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format.
SecondLimited	Boolean	Indicates whether level-2 throttling is configured.	Valid values: true false
AddressName	String	The EIP name.	None.
BandwidthPackageBandwidth	String	The bandwidth of the Internet Shared Bandwidth instance with which the EIP is associated.	Unit: Mbit/s.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceType:
    Description: 'The type of the current bound instance.
      - EcsInstance: an ECS instance of the VPC type.
      - SlbInstance: an SLB instance of the VPC type.
      - Nat:NAT gateway.
      - HaVip: a highly available virtual IP address.
      - NetworkInterface: Secondary ENI.'
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      InstanceType:
        Ref: InstanceType
    Type: DATASOURCE::EIP::Addresses
Outputs:
  Addresses:
    Description: The details about the EIP
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Addresses
  AllocationIds:
    Description: The list of allocation IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AllocationIds

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceType": {
      "Description": "The type of the current bound instance. - EcsInstance: an ECS instance of the VPC type. - SlbInstance: an SLB instance of the VPC type. - Nat:NAT gateway. - HaVip: a highly available virtual IP address. - NetworkInterface: Secondary ENI.",
      "Type": "String"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Properties": {
        "InstanceType": {
          "Ref": "InstanceType"
        }
      },
      "Type": "DATASOURCE::EIP::Addresses"
    }
  },
  "Outputs": {
    "Addresses": {
      "Description": "The details about the EIP",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Addresses"
        ]
      }
    },
    "AllocationIds": {
      "Description": "The list of allocation IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AllocationIds"
        ]
      }
    }
  }
}