DescribeAccessInstanceTask API Overview - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Queries the task progress of a synchronization node.

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-cloudfirewall:DescribeAccessInstanceTask

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AccessInstanceId	string	No	The synchronization node ID. You must specify at least one of AccessInstanceId and TaskId. If both are empty, the error MissingParameter.TaskIdOrAccessInstanceId (-200550) is returned.	pdi-3bc2f91695ee48bd9377
RegionNo	string	No	The region ID.	cn-beijing
Lang	string	No	The language of the response message. Valid values: en : English. zh : Chinese (default)	zh
TaskId	string	No	The task ID. You must specify at least one of TaskId and AccessInstanceId. If both are empty, the error MissingParameter.TaskIdOrAccessInstanceId (-200550, TaskId and AccessInstanceId cannot be empty at the same time. Provide at least one.) is returned.	task-c92d4544ef7b6a42
AccessInstanceType	string	No	The synchronization node type. Valid values: AckClusterConnector : ACK cluster connector. PrivateDNS : Private DNS.	AckClusterConnector

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	15FCCC52-1E23-57AE-B5EF-3E00A3******
IsFound	boolean	Indicates whether the task exists.	true
TaskStatus	string	The task status.	running
TaskName	string	The task name.	Create an ACK cluster connector
TaskId	string	The task ID.	3c9d576f-fce0-4caa-9116-15033509bdb6
TaskStartTimestamp	integer	The task creation time.	17151361285
TaskFinishTimestamp	integer	The task completion time.	17151381075
TaskSteps	array<object>	The task steps.
	object	The task steps.
StepName	string	The step name.	Obtain ACK cluster information
StepStatus	string	The step status.	finished
StepProgress	string	The step progress.	100%

Examples

Success response

JSON format

{
  "RequestId": "15FCCC52-1E23-57AE-B5EF-3E00A3******",
  "IsFound": true,
  "TaskStatus": "running",
  "TaskName": "Create an ACK cluster connector",
  "TaskId": "3c9d576f-fce0-4caa-9116-15033509bdb6",
  "TaskStartTimestamp": 17151361285,
  "TaskFinishTimestamp": 17151381075,
  "TaskSteps": [
    {
      "StepName": "Obtain ACK cluster information",
      "StepStatus": "finished",
      "StepProgress": "100%"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParameters	taskId and AccessInstanceId can not be empty at the same time.
400	MissingParameter.TaskIdOrAccessInstanceId	TaskId and AccessInstanceId cannot be empty at the same time. Provide at least one.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.