DATASOURCE::VPC::CommonBandwidthPackage - Consultar Internet Shared Bandwidth - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Consulta uma instância de Internet Shared Bandwidth na região especificada.

Sintaxe

{
  "Type": "DATASOURCE::VPC::CommonBandwidthPackage",
  "Properties": {
    "CommonBandwidthPackageName": String,
    "CommonBandwidthPackageId": String,
    "RefreshOptions": String
  }
}

Propriedades

Propriedade	Tipo	Obrigatória	Editável	Descrição	Restrição
CommonBandwidthPackageName	String	Não	Sim	Nome da instância.	Nenhuma.
CommonBandwidthPackageId	String	Não	Sim	ID da instância.	Nenhuma.
RefreshOptions	String	Não	Sim	Política de atualização da source de dados durante atualizações da pilha.	Valores válidos: Never (padrão): não atualiza os recursos da source de dados durante atualizações da pilha. Always: atualiza os recursos da source de dados durante atualizações da pilha.

Valores de retorno

Fn::GetAtt

Status: status da instância.
Description: descrição da instância.
ResourceGroupId: ID do grupo de recursos.
CommonBandwidthPackageName: nome da instância.
ServiceManaged: indica se a conta de serviço criou o recurso.
InstanceChargeType: método de faturamento da instância.
Isp: tipo de linha.
HasReservationData: indica se informações sobre pedidos pendentes foram retornadas.
DeletionProtection: indica se a proteção contra exclusão está ativada.
BusinessStatus: status de serviço da instância.
ReservationInternetChargeType: método de faturamento após alterações de configuração.
InternetChargeType: método de faturamento da instância.
ReservationOrderType: método de renovação.
Bandwidth: largura de banda máxima da instância.
ExpiredTime: hora de expiração da instância.
CreationTime: hora de criação da instância.
PublicIpAddresses: endereços IP públicos associados à instância.
Ratio: porcentagem mínima de comprometimento de largura de banda.
ReservationActiveTime: hora em que a renovação entra em vigor.
ReservationBandwidth: nova largura de banda máxima após alterações de configuração.
CommonBandwidthPackageId: ID da instância.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CommonBandwidthPackageName:
    Type: String
    Description:
      en: The name of the Internet Shared Bandwidth instance.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::VPC::CommonBandwidthPackage
    Properties:
      CommonBandwidthPackageName:
        Ref: CommonBandwidthPackageName
Outputs:
  Status:
    Description: |-
      The status of the Internet Shared Bandwidth instance. Valid values:
      * Available: The Internet Shared Bandwidth instance is available.
      * Modifying: The Internet Shared Bandwidth instance is being modified.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Status
  Description:
    Description: The description of the Internet Shared Bandwidth instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  CommonBandwidthPackageName:
    Description: The name of the Internet Shared Bandwidth instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CommonBandwidthPackageName
  ServiceManaged:
    Description: |-
      Indicates whether the resource is created by the service account. Valid values:
      * 0: The resource is not created by the service account.
      * 1: The resource is created by the service account.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ServiceManaged
  InstanceChargeType:
    Description: |-
      The billing method of the Internet Shared Bandwidth instance. Valid value:
      * PostPaid: pay-as-you-go
      * PrePaid: subscription
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceChargeType
  Isp:
    Description: |-
      The line type. Valid values:
      BGP (default): BGP (Multi-ISP) lines.
      BGP_PRO: BGP (Multi-ISP) Pro lines.
      Valid values if you are allowed to use single-ISP bandwidth:
      ChinaTelecom
      ChinaUnicom
      ChinaMobile
      ChinaTelecom_L2
      ChinaUnicom_L2
      ChinaMobile_L2
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Isp
  HasReservationData:
    Description: |-
      Indicates whether the information about pending orders is returned. Valid values:
      * false
      * true
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - HasReservationData
  DeletionProtection:
    Description: |-
      Indicates whether deletion protection is enabled. Valid values:
      * false
      * true
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DeletionProtection
  BusinessStatus:
    Description: |-
      The service status of the Internet Shared Bandwidth instance. Valid values:
      * Normal: The Internet Shared Bandwidth instance runs as expected.
      * FinancialLocked: An overdue payment occurs in the Internet Shared Bandwidth instance
      * Unactivated: The Internet Shared Bandwidth instance is not activated.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BusinessStatus
  ReservationInternetChargeType:
    Description: |-
      The billing method after the configurations are changed. Valid value:
      * PayBy95: Charged by Enhanced 95th Percentile.
      * PayByBandwidth: Charged by Bandwidth.
      * PayByDominantTraffic: Charged by Dominant Traffic.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReservationInternetChargeType
  InternetChargeType:
    Description: |-
      The billing method of the Internet Shared Bandwidth instance. Valid value:
      * PayBy95: Charged by Enhanced 95th Percentile.
      * PayByBandwidth: Charged by Bandwidth.
      * PayByDominantTraffic: Charged by Dominant Traffic.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InternetChargeType
  ReservationOrderType:
    Description: |-
      The renewal method. Valid values:
      * RENEWCHANGE: renewal with a specification change
      * TEMP_UPGRADE: renewal with a temporary upgrade
      * UPGRADE: renewal with an upgrade
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReservationOrderType
  Bandwidth:
    Description: 'The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Bandwidth
  ExpiredTime:
    Description: The time when the Internet Shared Bandwidth instance expired. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpiredTime
  CreationTime:
    Description: The time when the Internet Shared Bandwidth instance was created. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreationTime
  PublicIpAddresses:
    Description: The elastic IP addresses (EIPs) that are associated with the Internet Shared Bandwidth instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PublicIpAddresses
  Ratio:
    Description: The percentage of the minimum bandwidth commitment. Only 20 is returned.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Ratio
  ReservationActiveTime:
    Description: The time when the renewal took effect. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReservationActiveTime
  ReservationBandwidth:
    Description: 'The new maximum bandwidth after the configurations are changed. Unit: Mbit/s.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReservationBandwidth
  CommonBandwidthPackageId:
    Description: The ID of the Internet shared bandwidth.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CommonBandwidthPackageId

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CommonBandwidthPackageName": {
      "Type": "String",
      "Description": {
        "en": "The name of the Internet Shared Bandwidth instance."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::CommonBandwidthPackage",
      "Properties": {
        "CommonBandwidthPackageName": {
          "Ref": "CommonBandwidthPackageName"
        }
      }
    }
  },
  "Outputs": {
    "Status": {
      "Description": "The status of the Internet Shared Bandwidth instance. Valid values:\n* Available: The Internet Shared Bandwidth instance is available.\n* Modifying: The Internet Shared Bandwidth instance is being modified.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Status"
        ]
      }
    },
    "Description": {
      "Description": "The description of the Internet Shared Bandwidth instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "CommonBandwidthPackageName": {
      "Description": "The name of the Internet Shared Bandwidth instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommonBandwidthPackageName"
        ]
      }
    },
    "ServiceManaged": {
      "Description": "Indicates whether the resource is created by the service account. Valid values:\n* 0: The resource is not created by the service account.\n* 1: The resource is created by the service account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceManaged"
        ]
      }
    },
    "InstanceChargeType": {
      "Description": "The billing method of the Internet Shared Bandwidth instance. Valid value:\n* PostPaid: pay-as-you-go\n* PrePaid: subscription",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceChargeType"
        ]
      }
    },
    "Isp": {
      "Description": "The line type. Valid values:\nBGP (default): BGP (Multi-ISP) lines.\nBGP_PRO: BGP (Multi-ISP) Pro lines.\nValid values if you are allowed to use single-ISP bandwidth:\nChinaTelecom\nChinaUnicom\nChinaMobile\nChinaTelecom_L2\nChinaUnicom_L2\nChinaMobile_L2",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Isp"
        ]
      }
    },
    "HasReservationData": {
      "Description": "Indicates whether the information about pending orders is returned. Valid values:\n* false\n* true",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HasReservationData"
        ]
      }
    },
    "DeletionProtection": {
      "Description": "Indicates whether deletion protection is enabled. Valid values:\n* false\n* true",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeletionProtection"
        ]
      }
    },
    "BusinessStatus": {
      "Description": "The service status of the Internet Shared Bandwidth instance. Valid values:\n* Normal: The Internet Shared Bandwidth instance runs as expected.\n* FinancialLocked: An overdue payment occurs in the Internet Shared Bandwidth instance\n* Unactivated: The Internet Shared Bandwidth instance is not activated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BusinessStatus"
        ]
      }
    },
    "ReservationInternetChargeType": {
      "Description": "The billing method after the configurations are changed. Valid value:\n* PayBy95: Charged by Enhanced 95th Percentile.\n* PayByBandwidth: Charged by Bandwidth.\n* PayByDominantTraffic: Charged by Dominant Traffic.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationInternetChargeType"
        ]
      }
    },
    "InternetChargeType": {
      "Description": "The billing method of the Internet Shared Bandwidth instance. Valid value:\n* PayBy95: Charged by Enhanced 95th Percentile.\n* PayByBandwidth: Charged by Bandwidth.\n* PayByDominantTraffic: Charged by Dominant Traffic.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InternetChargeType"
        ]
      }
    },
    "ReservationOrderType": {
      "Description": "The renewal method. Valid values:\n* RENEWCHANGE: renewal with a specification change\n* TEMP_UPGRADE: renewal with a temporary upgrade\n* UPGRADE: renewal with an upgrade",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationOrderType"
        ]
      }
    },
    "Bandwidth": {
      "Description": "The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Bandwidth"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "The time when the Internet Shared Bandwidth instance expired. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpiredTime"
        ]
      }
    },
    "CreationTime": {
      "Description": "The time when the Internet Shared Bandwidth instance was created. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreationTime"
        ]
      }
    },
    "PublicIpAddresses": {
      "Description": "The elastic IP addresses (EIPs) that are associated with the Internet Shared Bandwidth instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddresses"
        ]
      }
    },
    "Ratio": {
      "Description": "The percentage of the minimum bandwidth commitment. Only 20 is returned.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Ratio"
        ]
      }
    },
    "ReservationActiveTime": {
      "Description": "The time when the renewal took effect. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationActiveTime"
        ]
      }
    },
    "ReservationBandwidth": {
      "Description": "The new maximum bandwidth after the configurations are changed. Unit: Mbit/s.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationBandwidth"
        ]
      }
    },
    "CommonBandwidthPackageId": {
      "Description": "The ID of the Internet shared bandwidth.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommonBandwidthPackageId"
        ]
      }
    }
  }
}