All Products
Search
Document Center

Anti-DDoS:DescribeInstanceExt

Last Updated:Oct 23, 2024

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

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:
    • The required resource types are displayed in bold characters.
    • 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-ddoscoo:DescribeInstanceExtget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringNo

The ID of the instance.

Note You can call the DescribeInstanceIds operation to query the IDs of all instances.
ddoscoo-cn-i7m25564****
PageNumberstringNo

The number of the page. For example, to query the returned results on the first page, set the value to 1.

1
PageSizestringNo

The number of entries per page.

10

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

CF33B4C3-196E-4015-AADD-5CAD00057B80
InstanceExtSpecsarray<object>

The extended information about the Anti-DDoS Proxy instance.

InstanceExtSpecsobject
InstanceIdstring

The ID of the instance.

ddoscoo-cn-i7m25564****
NormalBandwidthlong

The clean bandwidth. Unit: Mbit/s.

100
FunctionVersionlong

The function plan. Valid values:

  • 0: Standard
  • 1: Enhanced
0
ServicePartnerstring

The Internet service provider (ISP) line of the Anti-DDoS Proxy (Chinese Mainland) instance.

coop-line-001
ProductPlanlong

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
TotalCountlong

The total number of queried instances.

10

Examples

Sample success responses

JSONformat

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

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