Documentation
Home Page Anti-DDoS Anti-DDoS Native Developer Reference API Reference(2018-07-20) API catalog Other DescribeDdosOriginInstanceBill

DescribeDdosOriginInstanceBill

Updated at:
Copy as MD
Product

Queries the bill of an Anti-DDoS Origin (Pay-as-you-go) instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-antiddosbag:DescribeDdosOriginInstanceBill

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
Type

string

No

The bill type. Valid values:

  • flow_cn: the bill for the clean bandwidth of elastic IP addresses (EIPs) with Anti-DDoS (Enhanced) enabled in the Chinese mainland.

  • flow_ov: the bill for the clean bandwidth of EIPs with Anti-DDoS (Enhanced) enabled outside the Chinese mainland.

  • standard_assets_flow_cn: the bill for the clean bandwidth of regular Alibaba Cloud services in the Chinese mainland.

  • standard_assets_flow_ov: the bill for the clean bandwidth of regular Alibaba Cloud services outside the Chinese mainland.

  • function: the bill for the basic fee.

  • ip_count: the bill for protected IP addresses.

  • monthly_summary: the monthly summary bill.

function
StartTime

integer

No

The beginning of the time range to query. The value is a timestamp. Unit: milliseconds.

1711209600410
EndTime

integer

No

The end of the time range to query. The value is a timestamp. Unit: milliseconds. The time span between StartTime and EndTime cannot exceed 30 days.

1711382399410
IsShowList

boolean

No

Specifies whether to display the bill details. Valid values:

  • true

  • false

false

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

72155560-F343-55C8-82FE-ED4D7E4AA97E
Status

integer

The instance status. Valid values:

  • 1: normal

  • 2: expired

  • 3: released

1
DebtStatus

integer

The payment status. Valid values:

  • 0: The payment is not overdue.

  • 1: The payment is overdue.

0
InstanceId

string

The ID of the Anti-DDoS Origin (Pay-as-you-go) instance to query.

ddosorigin_cn-u7c3lcr9r02
IpCount

integer

The number of protected IP addresses.

15
IpInfo

string

The IP address distribution. The JSON struct contains the following fields:

  • eipCnIpCount: the number of EIPs with Anti-DDoS (Enhanced) enabled in the Chinese mainland.

  • eipOvIpCount: the number of EIPs with Anti-DDoS (Enhanced) enabled outside the Chinese mainland.

  • standardAssetsCnIpCount: the number of IP addresses of regular Alibaba Cloud services in the Chinese mainland.

  • standardAssetsOvIpCount: the number of IP addresses of regular Alibaba Cloud services outside the Chinese mainland.

{\"eipCnIpCount\":6,\"eipOvIpCount\":17,\"standardAssetsCnIpCount\":2,\"standardAssetsOvIpCount\":0}
TotalFlowCn

integer

The total traffic of EIPs with Anti-DDoS (Enhanced) enabled in the Chinese mainland in the current month. Unit: bytes.

6302081067
TotalFlowOv

integer

The total traffic of EIPs with Anti-DDoS (Enhanced) enabled outside the Chinese mainland in the current month. Unit: bytes.

6204918019
StandardAssetsTotalFlowCn

integer

The total traffic of regular Alibaba Cloud services in the Chinese mainland in the current month.

0
StandardAssetsTotalFlowOv

integer

The total traffic of regular Alibaba Cloud services outside the Chinese mainland in the current month.

0
IpCountOrFunctionList

array<object>

The protected IP addresses and enabled features.

object

The protected IP addresses and enabled features.

Coverage

string

The application scope of the instance. Valid values:

  • only_mainland_china: regions in the Chinese mainland.

  • global: all regions.

  • international_and_hmt: regions outside the Chinese mainland.

global
IpCntCn

integer

The number of IP addresses protected by the pay-as-you-go instance in the Chinese mainland.

5
IpCntOv

integer

The number of IP addresses protected by the pay-as-you-go instance outside the Chinese mainland.

5
Time

integer

The billing time. Unit: milliseconds.

1680278400000
MemberIpCnt

string

The bill distribution by account. The JSON struct contains the following fields:

  • eipCnIpCount: the number of EIPs with Anti-DDoS (Enhanced) enabled in the Chinese mainland.

  • eipOvIpCount: the number of EIPs with Anti-DDoS (Enhanced) enabled outside the Chinese mainland.

  • memberUid: the owner account.

  • standardAssetsCnIpCount: the number of IP addresses of regular Alibaba Cloud services in the Chinese mainland.

  • standardAssetsOvIpCount: the number of IP addresses of regular Alibaba Cloud services outside the Chinese mainland.

Note

If the memberUid field in the JSON struct is empty, the information about the current account is returned.

[{\"eipCnIpCount\":3,\"eipOvIpCount\":18,\"memberUid\":\"\",\"standardAssetsCnIpCount\":2,\"standardAssetsOvIpCount\":0},{\"eipCnIpCount\":3,\"eipOvIpCount\":0,\"memberUid\":\"1776997906319249\",\"standardAssetsCnIpCount\":0,\"standardAssetsOvIpCount\":0}]
FlowList

array<object>

The details about the traffic of EIPs with Anti-DDoS (Enhanced) enabled.

object

The information about the traffic of the Anti-DDoS Origin instance.

TotalFlow

integer

The traffic of EIPs with Anti-DDoS (Enhanced) enabled. Unit: bytes.

6302081067
TotalBillFlow

integer

The total IP traffic of regular Alibaba Cloud services.

6302081067
RegionFlow

string

The traffic distribution by region. The JSON struct contains the following fields:

  • bytes: the traffic volume of EIPs with Anti-DDoS (Enhanced) enabled in a region. Unit: bytes.

  • instanceId: the ID of the pay-as-you-go instance that protects the EIPs with Anti-DDoS (Enhanced) enabled.

  • ip: the EIPs with Anti-DDoS (Enhanced) enabled.

  • region: the region.

{\"cn-hangzhou\":[{\"bytes\":0,\"instanceId\":\"ddosorigin_cn-u7c3lcr9r02\",\"ip\":\"47.118.168.124\",\"region\":\"cn-hangzhou\"}]}
Time

integer

The timestamp. Unit: milliseconds.

1620951900
MemberFlow

string

The traffic distribution by region. The JSON struct contains the following fields:

  • bytes: the traffic volume of EIPs with Anti-DDoS (Enhanced) enabled in a region. Unit: bytes.

  • memberUid: the owner account.

  • instanceId: the ID of the pay-as-you-go instance that protects the EIPs with Anti-DDoS (Enhanced) enabled.

  • ip: the EIPs with Anti-DDoS (Enhanced) enabled.

  • region: the region.

Note

If the memberUid field in the JSON struct is empty, the information about the current account is returned. The value of the bytes parameter in the outermost level of the JSON struct indicates the total traffic, and the values of the bytes parameters in inner levels indicate the traffic of the account.

[{\"bytes\":79282719,\"memberUid\":\"\",\"regionFlows\":{\"cn-hangzhou\":[{\"bytes\":79282719,\"instanceId\":\"ddosorigin_cn-u7c3lcr9r02\",\"ip\":\"47.118.168.57\",\"region\":\"cn-hangzhou\"}]}}]
StandardAssetsFlowList

array<object>

The details about the traffic of regular Alibaba Cloud services.

object

The details about the traffic of a regular Alibaba Cloud service.

TotalFlow

integer

The traffic of regular Alibaba Cloud services. Unit: bytes.

6302081067
RegionFlow

string

The traffic distribution by region. The JSON struct contains the following fields:

  • bytes: the traffic volume of regular Alibaba Cloud services in a region. Unit: bytes.

  • instanceId: the ID of the pay-as-you-go instance that protects the regular Alibaba Cloud services.

  • ip: the IP address protected by the Anti-DDoS Origin instance.

  • region: the region.

{\"cn-hangzhou\":[{\"bytes\":0,\"instanceId\":\"ddosorigin_cn-u7c3lcr9r02\",\"ip\":\"47.118.168.124\",\"region\":\"cn-hangzhou\"}]}
Time

integer

The timestamp. Unit: milliseconds.

1679846400000
MemberFlow

string

The traffic distribution by region. The JSON struct contains the following fields:

  • bytes: the traffic volume of regular Alibaba Cloud services in a region. Unit: bytes.

  • memberUid: the owner account.

  • instanceId: the ID of the pay-as-you-go instance that protects the regular Alibaba Cloud services.

  • ip: the IP address of the regular Alibaba Cloud service protected by the Anti-DDoS Origin instance.

  • region: the region.

Note

If the memberUid field in the JSON struct is empty, the information about the current account is returned. The value of the bytes parameter in the outermost level of the JSON struct indicates the total traffic, and the values of the bytes parameters in inner levels indicate the traffic of the account.

[{\"bytes\":79282719,\"memberUid\":\"\",\"regionFlows\":{\"cn-hangzhou\":[{\"bytes\":79282719,\"instanceId\":\"ddosorigin_cn-u7c3lcr9r02\",\"ip\":\"47.118.168.57\",\"region\":\"cn-hangzhou\"}]}}]
FlowRegion

object

The traffic distribution of EIPs with Anti-DDoS (Enhanced) enabled by region.

{'cn-hongkong': 166491566}
StandardAssetsFlowRegion

object

The traffic distribution of regular Alibaba Cloud services by region.

{'cn-hongkong': 166491566}

AssetStatus

integer

The asset status.

  • 0: No asset is added to the instance for protection.

  • 1: Assets are added to the instance for protection.

0
MonthlySummaryList

array<object>

The information about the monthly summary bills.

object

The information about the monthly summary bill.

Uid

string

The ID of the administrator account.

102518028277****
MemberUid

string

The ID of the member.

112873971277****
EnableDays

integer

The number of days that the instance is activated.

30
StandardAssetsFlowCn

integer

The total traffic of regular Alibaba Cloud services in the Chinese mainland. Unit: bytes.

123456
StandardAssetsFlowIntl

integer

The total traffic of regular Alibaba Cloud services outside the Chinese mainland. Unit: bytes.

123456
FlowCn

integer

The total traffic of EIPs with Anti-DDoS (Enhanced) enabled in the Chinese mainland. Unit: bytes.

123456
FlowIntl

integer

The total traffic of EIPs with Anti-DDoS (Enhanced) enabled outside the Chinese mainland. Unit: bytes.

123456
IpCountCn

integer

The total number of protected IP addresses in the Chinese mainland.

Note

The total number of protected IP addresses is the sum of the daily numbers of protected IP addresses in a month.

28
IpCountIntl

integer

The total number of protected IP addresses outside the Chinese mainland.

Note

The total number of protected IP addresses is the sum of the daily numbers of protected IP addresses in a month.

30

Examples

Success response

JSON format

{
  "RequestId": "72155560-F343-55C8-82FE-ED4D7E4AA97E",
  "Status": 1,
  "DebtStatus": 0,
  "InstanceId": "ddosorigin_cn-u7c3lcr9r02",
  "IpCount": 15,
  "IpInfo": "{\\\"eipCnIpCount\\\":6,\\\"eipOvIpCount\\\":17,\\\"standardAssetsCnIpCount\\\":2,\\\"standardAssetsOvIpCount\\\":0}",
  "TotalFlowCn": 6302081067,
  "TotalFlowOv": 6204918019,
  "StandardAssetsTotalFlowCn": 0,
  "StandardAssetsTotalFlowOv": 0,
  "IpCountOrFunctionList": [
    {
      "Coverage": "global",
      "IpCntCn": 5,
      "IpCntOv": 5,
      "Time": 1680278400000,
      "MemberIpCnt": "[{\\\"eipCnIpCount\\\":3,\\\"eipOvIpCount\\\":18,\\\"memberUid\\\":\\\"\\\",\\\"standardAssetsCnIpCount\\\":2,\\\"standardAssetsOvIpCount\\\":0},{\\\"eipCnIpCount\\\":3,\\\"eipOvIpCount\\\":0,\\\"memberUid\\\":\\\"1776997906319249\\\",\\\"standardAssetsCnIpCount\\\":0,\\\"standardAssetsOvIpCount\\\":0}]"
    }
  ],
  "FlowList": [
    {
      "TotalFlow": 6302081067,
      "TotalBillFlow": 6302081067,
      "RegionFlow": "{\\\"cn-hangzhou\\\":[{\\\"bytes\\\":0,\\\"instanceId\\\":\\\"ddosorigin_cn-u7c3lcr9r02\\\",\\\"ip\\\":\\\"47.118.168.124\\\",\\\"region\\\":\\\"cn-hangzhou\\\"}]}",
      "Time": 1620951900,
      "MemberFlow": "[{\\\"bytes\\\":79282719,\\\"memberUid\\\":\\\"\\\",\\\"regionFlows\\\":{\\\"cn-hangzhou\\\":[{\\\"bytes\\\":79282719,\\\"instanceId\\\":\\\"ddosorigin_cn-u7c3lcr9r02\\\",\\\"ip\\\":\\\"47.118.168.57\\\",\\\"region\\\":\\\"cn-hangzhou\\\"}]}}]"
    }
  ],
  "StandardAssetsFlowList": [
    {
      "TotalFlow": 6302081067,
      "RegionFlow": "{\\\"cn-hangzhou\\\":[{\\\"bytes\\\":0,\\\"instanceId\\\":\\\"ddosorigin_cn-u7c3lcr9r02\\\",\\\"ip\\\":\\\"47.118.168.124\\\",\\\"region\\\":\\\"cn-hangzhou\\\"}]}",
      "Time": 1679846400000,
      "MemberFlow": "[{\\\"bytes\\\":79282719,\\\"memberUid\\\":\\\"\\\",\\\"regionFlows\\\":{\\\"cn-hangzhou\\\":[{\\\"bytes\\\":79282719,\\\"instanceId\\\":\\\"ddosorigin_cn-u7c3lcr9r02\\\",\\\"ip\\\":\\\"47.118.168.57\\\",\\\"region\\\":\\\"cn-hangzhou\\\"}]}}]"
    }
  ],
  "FlowRegion": {
    "test": "test",
    "test2": 1
  },
  "StandardAssetsFlowRegion": {
    "test": "test",
    "test2": 1
  },
  "AssetStatus": 0,
  "MonthlySummaryList": [
    {
      "Uid": "102518028277****",
      "MemberUid": "112873971277****",
      "EnableDays": 30,
      "StandardAssetsFlowCn": 123456,
      "StandardAssetsFlowIntl": 123456,
      "FlowCn": 123456,
      "FlowIntl": 123456,
      "IpCountCn": 28,
      "IpCountIntl": 30
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Previous：ReleaseDdosOriginInstanceNext：MoveResourceGroup