ListInstance

Queries 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

ddosdiversion:ListInstance

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SaleId	string	No	The ID of the Anti-DDoS Diversion instance.	ddos_diversion_public_cn-xxxxxxxxxxxxx
Name	string	No	The name of the instance.	Test instance.
Status	string	No	The status of the instance. Valid values: normal: The instance is running normally. expired: The instance has expired. deleting: The instance is being deleted. stopped: The instance is stopped.	normal
Page	integer	No	The number of the page to return. Default value: 1.	1
Num	integer	No	The number of entries to return. Default value: 100.	100

Response elements

Element	Type	Description	Example
	object
Code	integer	The response code. Valid values: 200: The request was successful. Other codes: The request failed.	200
RequestId	string	The request ID, which is used to locate and troubleshoot issues.	B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95
Message	string	The additional information that is returned.	successful
Data	object	The returned result.
Total	integer	The total number of returned entries.	10
Page	integer	The number of the page to return.	1
Num	integer	The number of entries.	100
Instances	array<object>	The details of the anti-DDoS diversion instance.
	array<object>
UserId	string	The user ID.	177xxxxxxxxxxxxx
SaleId	string	The ID of the anti-DDoS diversion instance.	ddos_diversion_public_cn-xxxxxxxxxxxxx
InstanceId	string	The instance ID.	ddos_diversion_public_cn-xxxxxxxxxxxxx_xxxxxx
Name	string	The name of the instance.	Test instance.
Status	string	The status of the instance. Valid values: normal: The instance is running normally. expired: The instance has expired. deleting: The instance is being deleted. stopped: The instance is stopped.	normal
Comment	string	The description.	Test instance.
Message	string	The configurations of the instance.	successful
Spec	object	The specifications.
IdcNumbers	string	The number of data centers. Valid values: 1-10.	1
NormalBandwidth	string	The service traffic. Unit: Mbps.	100
IpSubnetNums	string	The number of CIDR blocks. Valid values: 1-10000.	1
Coverage	string	The region of the asset.	international_and_hmt
Edition	string	The mitigation plan.	enterprise
MitigationCapacity	string	The maximum mitigation capability.	unlimited
MitigationNums	string	The mitigation sessions.	unlimited
DiversionType	string	The diversion mode. Valid values: on-demand; always-on.	on-demand
MitigationAnalysis	string	The mitigation analysis feature.	off
MitigationAnalysisCapacity	string	The log storage capacity.	3T
InitialInstallation	string	The initial installation mode.	gre_tunnel_by_pccw
InitialQty	string	The initial installation quantity.	1
GmtExpire	string	The expiration time.	2022-12-15 11:10:42
GmtCreate	string	The purchase time.	2022-12-15 11:10:42
GmtModify	string	The update time.	2022-12-15 11:10:42

Examples

Success response

JSON format

{
  "Code": 200,
  "RequestId": "B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95",
  "Message": "successful",
  "Data": {
    "Total": 10,
    "Page": 1,
    "Num": 100,
    "Instances": [
      {
        "UserId": "177xxxxxxxxxxxxx",
        "SaleId": "ddos_diversion_public_cn-xxxxxxxxxxxxx",
        "InstanceId": "ddos_diversion_public_cn-xxxxxxxxxxxxx_xxxxxx",
        "Name": "Test instance.",
        "Status": "normal",
        "Comment": "Test instance.",
        "Message": "successful",
        "Spec": {
          "IdcNumbers": "1",
          "NormalBandwidth": "100",
          "IpSubnetNums": "1",
          "Coverage": "international_and_hmt",
          "Edition": "enterprise",
          "MitigationCapacity": "unlimited",
          "MitigationNums": "unlimited",
          "DiversionType": "on-demand",
          "MitigationAnalysis": "off",
          "MitigationAnalysisCapacity": "3T",
          "InitialInstallation": "gre_tunnel_by_pccw",
          "InitialQty": "1"
        },
        "GmtExpire": "2022-12-15 11:10:42",
        "GmtCreate": "2022-12-15 11:10:42",
        "GmtModify": "2022-12-15 11:10:42"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	AuthenticationFailed	User authentication failed.	User authentication failed.
400	AutoScheduleRuleExist	The auto schedule rule already exists.	The scheduling rule already exists.
400	AutoScheduleRuleNotExist	The auto schedule rule dose not exist.	The scheduling rule does not exist.
400	BlackHoleConfigurationError	A black hole configuration error occurred.	The blackhole filtering configuration is invalid.
400	CleanConfigurationError	A clean configuration error occurred.	The traffic scrubbing configuration is invalid.
400	CoveredNet	The CIDR block is overwritten.	The specified CIDR block overlaps with another CIDR block.
400	DatabaseError	A database error.	The database is invalid.
400	DeclaredNet	The CIDR block has been advertised.	The CIDR block is in the Advertising state.
400	DefenseConfigurationError	A defense configuration error occurred.	The mitigation settings are invalid.
400	ForwardConfigurationNotExist	The CIDR block forwarding configuration is not found.	The forwarding configuration of the CIDR block does not exist.
400	ForwardNotExist	The CIDR block zone forwarding configuration is not found.	The zone forwarding configuration of the CIDR block does not exist.
400	ForwardRuleNotExist	The CIDR block forwarding rule is not found.	The CIDR block forwarding rule does not exist.
400	HttpFailed	HTTP request failed.	The HTTP request failed.
400	IDNSubnetsCountLimit	The maximum number of IDCs of the instance is exceeded.	The number of data centers for the instance has reached the upper limit.
400	InstanceExist	The instance already exists.	The instance already exists.
400	InstanceNetConfigurationExist	The instance CIDR block configuration already exists.	The CIDR block configuration of the instance already exists.
400	InstanceNotExist	The instance is not found.	The instance does not exist.
400	InstanceUpstreamLimit	The maximum number of reinjection configurations for the instance is exceeded.	The number of reinjection configurations of the instance is limited.
400	InternalError	An internal error occurred.	An internal error occurred.
400	InvalidNet	Invalid CIDR block.	The CIDR block is invalid.
400	InvalidParam	Invalid parameter value.	The parameter is invalid.
400	IPSubnetsCountLimit	The maximum number of CIDR blocks of the instance is exceeded.	The number of CIDR blocks of the instance has reached the upper limit.
400	NetCannotExtend	The CIDR block cannot be extended.	The CIDR block cannot be expanded.
400	NetConfigurationExist	The CIDR block configuration already exists.	The CIDR block configuration already exists.
400	NetConfigurationNotExist	The CIDR block configuration is not found.	The CIDR block configuration does not exist.
400	NetForwardDelete	The CIDR block forwarding is being deleted.	The forwarding configuration of the CIDR block is being deleted.
400	NetMaskOutOfRange	The subnet mask of the CIDR block is invalid.	The subnet mask exceeds the upper limit.
400	NetNeedExtend	The CIDR block needs to be extended.	The CIDR block needs to be expanded.
400	NetStatusNotReady	The CIDR block reinjection configuration has not been completed.	Failed to complete the reinjection configuration of the CIDR block.
400	NetworkDeclearedFailed	Failed to advertise the CIDR block.	Failed to advertise the CIDR block.
400	NetWorkNotExist	The CIDR block is not found.	The CIDR block does not exist.
400	NetworkUndeclearedFailed	Failed to cancel the advertisement of the CIDR block.	Failed to withdraw the advertising of the CIDR block.
400	ParameterNotEnough	Required parameters are not specified.	A required parameter is not specified.
400	ParameterOutOfRange	Invalid parameter value.	The value of the parameter is invalid.
400	RegionNotExist	The region does not exist.	The zone does not exist.
400	RequestMethodError	An incorrect request method.	The request method is invalid.
400	SubnetCountLimit	The maximum number of subnets is exceeded.	The number of subnets has reached the upper limit.
400	UnKnownError	An unknown error occurred.	An unknown error occurred.
400	UpsteamNotComplete	The reinjection configuration has not been completed.	Failed to complete the reinjection configuration of the CIDR block.
400	UpstreamConfigurationNotExist	The reinjection configuration is not found.	The reinjection configuration does not exist.
400	JsonDecodeError	JSON string decoding failed.	Failed to convert JSON string to JSON object.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.