Skip to Content
基础网络 UNet获取共享带宽信息 - DescribeShareBandwidth

获取共享带宽信息 - DescribeShareBandwidth

简介

获取共享带宽信息

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称，当前 API 为 DescribeShareBandwidthYes
PublicKeystring用户公钥，可从 控制台  获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名，参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口No
ShareBandwidthIds.Nstring需要返回的共享带宽IdNo

响应字段

字段名类型描述信息必填
RetCodeint返回状态码，为 0 则为成功返回，非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息，当 RetCode 非 0 时提供详细的描述信息No
DataSetarray[UnetShareBandwidthSet]共享带宽信息组 参见 UnetShareBandwidthSetNo
TotalCountint符合条件的共享带宽总数，大于等于返回DataSet长度No

数据模型

UnetShareBandwidthSet

字段名类型描述信息必填
IPVersionstring共享带宽类型Yes
ShareBandwidthint共享带宽值(预付费)/共享带宽峰值(后付费), 单位MbpsNo
ShareBandwidthIdstring共享带宽的资源IDNo
ChargeTypestring付费方式, 预付费:Year 按年,Month 按月,Dynamic 按需;后付费:PostPay(按月)No
CreateTimeint创建时间, 格式为Unix TimestampNo
ExpireTimeint过期时间, 格式为Unix TimestampNo
EIPSetarray[EIPSetData]EIP信息,详情见 EIPSetDataNo
Namestring共享带宽名称No

EIPSetData

字段名类型描述信息必填
BandwidthintEIP带宽值No
EIPAddrarray[EIPAddrSet]EIP的IP信息，详情见EIPAddrSetNo
EIPIdstringEIP资源IdNo

EIPAddrSet

字段名类型描述信息必填
OperatorNamestring运营商信息, 枚举值为: BGP: BGP; International: 国际.No
IPstring弹性IP地址No

示例

请求示例

https://api-ajyun.cachecenter.com/?Action=DescribeShareBandwidth
&Region=cn-bj2

响应示例

{
  "Action": "DescribeShareBandwidthResponse",
  "DataSet": [
    {
      "ChargeType": "Dynamic",
      "CreateTime": 1529660427,
      "EIPSet": [
        {
          "Bandwidth": 1000,
          "EIPAddr": [
            {
              "IP": "106.75.XX.XX",
              "OperatorName": "BGP"
            }
          ],
          "EIPId": "eip-XXXXX"
        }
      ],
      "ExpireTime": 1529898027,
      "Name": "test",
      "ShareBandwidth": 20,
      "ShareBandwidthId": "bwshare-XXXX"
    }
  ],
  "Request_uuid": "a36b7aec-3911-4096-9110-XXXXX",
  "RetCode": 0,
  "TotalCount": 1,
  "TotolCount": 2
}
获取辅助IP信息 - DescribePrivateIP获取共享带宽价格 - DescribeShareBandwidthPrice