DescribeDcdnUserResourcePackage - Edge Security Acceleration

You can call the DescribeDcdnUserResourcePackage operation to query information about all your resource plans, such as the total amount, remaining amount, effective time, expiration time, and status.

Operation description

Note

The call frequency for a single user is limited to 30 calls per second.

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

dcdn:DescribeDcdnUserResourcePackage

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Status	string	No	The status of the resource plan. The default value is valid. Valid values: valid: The resource plan is valid. closed: The resource plan is closed. exhaust: The resource plan is exhausted. Valid values: valid : valid exhaust : exhaust closed : closed	valid

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	96ED3127-EC7A-57C5-AFA6-A689B24B2530
ResourcePackageInfos	object
ResourcePackageInfo	array<object>	The list of resource plans.
	object	An array of ResourcePackageInfo objects.
EndTime	string	The expiration time. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC and complies with the ISO 8601 standard.	2022-08-24T16:00:00Z
Status	string	The status of the resource plan. Valid values: valid: The resource plan is valid. closed: The resource plan is closed. exhaust: The resource plan is exhausted.	valid
DisplayName	string	The name of the resource plan.	Downstream Data Package (Australia Sydney)
StartTime	string	The effective time. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC and complies with the ISO 8601 standard.	2021-08-24T04:09:22Z
CommodityCode	string	The commodity code of the resource plan.	dcdnpaybag
InstanceId	string	The ID of the resource plan.	CDNFLOWBAG-cn-7pp2bihrb01ii0
TemplateName	string	The name of the template.	FPT_dcdnpaybag_deadlineAcc_1541151058
CurrCapacity	string	The remaining amount of the resource plan. The unit for data transfer plans is byte. The unit for request plans is count.	10000000
InitCapacity	string	The total amount of the resource plan. The unit for data transfer plans is byte. The unit for request plans is count.	10000000
Region	string	The region.	CN
CurrCapacityShowValue	string	The display value of the remaining capacity of the instance.	49.975789
CurrCapacityShowUnit	string	The display unit of the remaining capacity of the instance.	GB
CurrCapacityBaseUnit	string	The base unit of the remaining capacity of the instance.	Byte
InitCapacityShowValue	string	The display value of the total capacity of the resource plan.	100.000000
InitCapacityShowUnit	string	The display unit of the total capacity of the resource plan.	GB
InitCapacityBaseUnit	string	The base unit of the total capacity of the resource plan.	Byte

Examples

Success response

JSON format

{
  "RequestId": "96ED3127-EC7A-57C5-AFA6-A689B24B2530",
  "ResourcePackageInfos": {
    "ResourcePackageInfo": [
      {
        "EndTime": "2022-08-24T16:00:00Z",
        "Status": "valid",
        "DisplayName": "Downstream Data Package (Australia Sydney)",
        "StartTime": "2021-08-24T04:09:22Z",
        "CommodityCode": "dcdnpaybag",
        "InstanceId": "CDNFLOWBAG-cn-7pp2bihrb01ii0",
        "TemplateName": "FPT_dcdnpaybag_deadlineAcc_1541151058",
        "CurrCapacity": "10000000",
        "InitCapacity": "10000000",
        "Region": "CN",
        "CurrCapacityShowValue": "49.975789\n",
        "CurrCapacityShowUnit": "GB\n",
        "CurrCapacityBaseUnit": "Byte",
        "InitCapacityShowValue": "100.000000\n",
        "InitCapacityShowUnit": "GB\n",
        "InitCapacityBaseUnit": "Byte"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	DcdnServiceNotFound	The DCDN service is not activated.	DCDN is not activated. Activate DCDN and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.