All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::EIP::Addresses

Last Updated:May 31, 2023

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
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

SegmentInstanceId

String

No

Yes

The ID of the contiguous EIP.

None

AddressName

String

No

Yes

The name of the EIP.

The name must be 1 to 128 characters in length and can contain letters, digits, underscores (_), and hyphens (-). The name 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 ID of the EIP that you want to query.

None

PaymentType

String

No

Yes

The billing method of the EIP.

Valid values:

  • PostPaid: pay-as-you-go

  • PrePaid: subscription

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: an IP address

  • NetworkInterface: a secondary elastic network interface (ENI)

  • HaVip: a high-availability virtual IP address (HAVIP)

  • Nat: a NAT gateway

  • SlbInstance: a Server Load Balancer (SLB) instance in a virtual private cloud (VPC)

  • EcsInstance: an Elastic Compute Service (ECS) instance in a VPC

Return values

Fn::GetAtt

  • Addresses: the list of EIPs.

  • AllocationIds: the IDs of the EIPs.

Property

Type

Description

Constraint

AllocationIds

List

The IDs of the EIPs.

None

Addresses

List

The EIPs.

None

BusinessStatus

String

The service status of the EIP.

None

ExpiredTime

String

The time when the EIP expires.

The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.

IpAddress

String

The IP address of the EIP.

None

AllocationId

String

The ID of the EIP.

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 EIP bandwidth plan.

Unit: Mbit/s.

BandwidthPackageId

String

The ID of the EIP bandwidth plan.

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 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 of the EIP.

The value public indicates the Internet.

InstanceType

String

The type of the instance that is associated with the EIP.

None

OperationLocks

List

Details about the locked EIPs.

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 type of the bandwidth.

Only CommonBandwidthPackage that specifies an EIP bandwidth plan is returned.

ServiceManaged

Integer

Indicates whether the EIP is created by using the service account.

Valid values:

  • 0: The EIP is created by using a non-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 is displayed in the YYYY-MM-DDThh:mm:ssZ format.

SecondLimited

Boolean

Indicates whether level-2 throttling is configured.

Valid values:

  • true

  • false

AddressName

String

The name of the EIP.

None

BandwidthPackageBandwidth

String

The bandwidth of the EIP bandwidth plan with which the EIP is associated.

Unit: Mbit/s.

Examples

YAML format

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 format

{
  "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"
        ]
      }
    }
  }
}