DescribeInstanceExt - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the information about Anti-DDoS Pro and Anti-DDoS Premium instances.

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-ddoscoo:DescribeInstanceExt

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the instance. Note You can call the DescribeInstanceIds operation to query the IDs of all instances.	ddoscoo-cn-i7m25564****
PageNumber	string	No	The number of the page. For example, to query the returned results on the first page, set the value to 1.	1
PageSize	string	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	CF33B4C3-196E-4015-AADD-5CAD00057B80
InstanceExtSpecs	array<object>	The extended information about the Anti-DDoS Proxy instance.
	object
InstanceId	string	The ID of the instance.	ddoscoo-cn-i7m25564****
NormalBandwidth	integer	The clean bandwidth. Unit: Mbit/s.	100
FunctionVersion	integer	The function plan. Valid values: 0: Standard 1: Enhanced	0
ServicePartner	string	The Internet service provider (ISP) line of the Anti-DDoS Proxy (Chinese Mainland) instance.	coop-line-001
ProductPlan	integer	The type of the instance. Valid values: 0: Anti-DDoS Proxy (Outside Chinese Mainland) instance of the Insurance mitigation plan 1: Anti-DDoS Proxy (Outside Chinese Mainland) instance of the Unlimited mitigation plan 2: Anti-DDoS Proxy (Outside Chinese Mainland) instance of the Chinese Mainland Acceleration (CMA) mitigation plan 3: Anti-DDoS Proxy (Outside Chinese Mainland) instance of the Secure Chinese Mainland Acceleration (Sec-CMA) mitigation plan 9: Anti-DDoS Proxy (Chinese Mainland) instance of the Profession mitigation plan	0
TotalCount	integer	The total number of queried instances.	10

Examples

Success response

JSON format

{
  "RequestId": "CF33B4C3-196E-4015-AADD-5CAD00057B80",
  "InstanceExtSpecs": [
    {
      "InstanceId": "ddoscoo-cn-i7m25564****\n",
      "NormalBandwidth": 100,
      "FunctionVersion": 0,
      "ServicePartner": "coop-line-001",
      "ProductPlan": 0
    }
  ],
  "TotalCount": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.