All Products
Search
Document Center

Anti-DDoS:DescribeDdosOriginInstanceBill

Last Updated:Mar 10, 2025

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-antiddosbag:DescribeDdosOriginInstanceBillget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TypestringNo

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
StartTimelongNo

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

1711209600410
EndTimelongNo

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
IsShowListbooleanNo

Specifies whether to display the bill details. Valid values:

  • true
  • false
false

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The instance status. Valid values:

  • 1: normal
  • 2: expired
  • 3: released
1
DebtStatuslong

The payment status. Valid values:

  • 0: The payment is not overdue.
  • 1: The payment is overdue.
0
InstanceIdstring

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

ddosorigin_cn-u7c3lcr9r02
IpCountlong

The number of protected IP addresses.

15
IpInfostring

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

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

6302081067
TotalFlowOvlong

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

6204918019
StandardAssetsTotalFlowCnlong

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

0
StandardAssetsTotalFlowOvlong

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

0
IpCountOrFunctionListarray<object>

The protected IP addresses and enabled features.

ipCountOrFunctionListobject

The protected IP addresses and enabled features.

Coveragestring

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
IpCntCnlong

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

5
IpCntOvlong

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

5
Timelong

The billing time. Unit: milliseconds.

1680278400000
MemberIpCntstring

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}]
FlowListarray<object>

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

flowListobject

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

TotalFlowlong

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

6302081067
TotalBillFlowlong

The traffic of IPs with Anti-DDoS enabled. Unit: bytes.

6302081067
RegionFlowstring

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\"}]}
Timelong

The timestamp. Unit: milliseconds.

1620951900
MemberFlowstring

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\"}]}}]
StandardAssetsFlowListarray<object>

The details about the traffic of regular Alibaba Cloud services.

standardAssetsFlowListobject

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

TotalFlowlong

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

6302081067
RegionFlowstring

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\"}]}
Timelong

The timestamp. Unit: milliseconds.

1679846400000
MemberFlowstring

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\"}]}}]
FlowRegionobject

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

{'cn-hongkong': 166491566}
StandardAssetsFlowRegionobject

The traffic distribution of regular Alibaba Cloud services by region.

{'cn-hongkong': 166491566}
AssetStatusinteger

The asset status.

  • 0: No asset is added to the instance for protection.
  • 1: Assets are added to the instance for protection.
0
MonthlySummaryListarray<object>

The information about the monthly summary bills.

monthlySummaryListobject

The information about the monthly summary bill.

Uidstring

The ID of the administrator account.

102518028277****
MemberUidstring

The ID of the member.

112873971277****
EnableDaysinteger

The number of days that the instance is activated.

30
StandardAssetsFlowCnlong

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

123456
StandardAssetsFlowIntllong

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

123456
FlowCnlong

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

123456
FlowIntllong

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

123456
IpCountCninteger

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
IpCountIntlinteger

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

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-01-15The response structure of the API has changedView Change Details
2024-11-13The response structure of the API has changedView Change Details
2024-08-21The response structure of the API has changedView Change Details