# Get shared bandwidth information - DescribeShareBandwidth

## Overview

Get shared bandwidth information






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeShareBandwidth`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.genesissai.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region. See [List of Regions and Availability Zones](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |**Yes**|
| **ShareBandwidthIds.N** | string | Shared Bandwidth Id to be returned |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **DataSet** | array[[*UnetShareBandwidthSet*](#unetsharebandwidthset)] | Shared Bandwidth Information Group See UnetShareBandwidthSet |No|
| **TotalCount** | int | The total shared bandwidth that meets the conditions, is greater than or equal to the returned DataSet length. |No|

#### Data Model


#### UnetShareBandwidthSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **IPVersion** | string | Shared Bandwidth Type |**Yes**|
| **ShareBandwidth** | int | Shared Bandwidth Value (Prepaid)/Shared Bandwidth Peak (Postpaid), Unit Mbps |No|
| **ShareBandwidthId** | string | Resource ID of Shared Bandwidth |No|
| **ChargeType** | string | Payment methods: Prepaid: Yearly, Monthly, Dynamic (on a time-based basis); Postpaid: PostPay (monthly) |No|
| **CreateTime** | int | Creation time, in Unix Timestamp format |No|
| **ExpireTime** | int | Expiration time, in Unix Timestamp format |No|
| **EIPSet** | array[[*EIPSetData*](#eipsetdata)] | EIP Information, see EIPSetData for details |No|
| **Name** | string | Shared Bandwidth Name |No|
| **Tag** | string | The business group identifier for shared bandwidth, the default value is "Default". |No|
| **LimitType** | string | Shared Bandwidth Throttling Type; Enum values: "Normal", "SpeedLimit |No|
| **AutoRenew** | string | Whether to enable auto-renewal for shared bandwidth; whether to enable auto-renewal; enumeration values: "Yes", "No |No|
| **OperatorName** | string | Operator name for ShareBandwid |No|

#### EIPSetData

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Bandwidth** | int | EIP Bandwidth Value |No|
| **EIPAddr** | array[[*EIPAddrSet*](#eipaddrset)] | EIP's IP information, see EIPAddrSet for details. |No|
| **EIPId** | string | EIP Resource Id |No|
| **FollowShareBandwidth** | boolean | Whether to enable the EIP follow-up shared bandwidth mode; in scenarios where ordinary shared bandwidth is bound and speed limit is enabled for follow-up, set FollowShareBandwidth to true, and set it to false in other scenarios |No|

#### EIPAddrSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **OperatorName** | string | Operator Information, enumeration values are: BGP: BGP; International: International. |No|
| **IP** | string | Elastic IP Address |No|

## Example

### Request Example
    
```
https://api.genesissai.com/?Action=DescribeShareBandwidth
&Region=cn-bj2
```

### Response Example
    
```json
{
  "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
}
```