DescribeAccessInstanceTask - 查询同步节点任务进度-云防火墙(Cloud Firewall)-阿里云帮助中心

查询同步节点任务进度。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cloudfirewall:DescribeAccessInstanceTask

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
AccessInstanceId	string	否	同步节点 ID。AccessInstanceId 与 TaskId 至少提供一个；两者均为空时返回 MissingParameter.TaskIdOrAccessInstanceId（-200550）。	pdi-3bc2f91695ee48bd9377
RegionNo	string	否	地域 ID。	cn-beijing
Lang	string	否	接收消息的语言类型。枚举值： en : 英文 zh : 中文（默认）	zh
TaskId	string	否	任务 ID。TaskId 与 AccessInstanceId 至少提供一个；两者均为空时返回 MissingParameter.TaskIdOrAccessInstanceId（-200550，TaskId and AccessInstanceId cannot be empty at the same time. Provide at least one.）。	task-c92d4544ef7b6a42
AccessInstanceType	string	否	同步节点类型。枚举值： AckClusterConnector : ACK 集群连接器 PrivateDNS : 私有 DNS	AckClusterConnector

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	15FCCC52-1E23-57AE-B5EF-3E00A3******
IsFound	boolean	是否存在任务。	true
TaskStatus	string	任务状态。	running
TaskName	string	任务名称。	Create an ACK cluster connector
TaskId	string	任务 ID。	3c9d576f-fce0-4caa-9116-15033509bdb6
TaskStartTimestamp	integer	任务创建时间。	17151361285
TaskFinishTimestamp	integer	任务完成时间。	17151381075
TaskSteps	array<object>	任务步骤。
	object	任务步骤。
StepName	string	步骤名称。	Obtain ACK cluster information
StepStatus	string	步骤状态。	finished
StepProgress	string	步骤进度。	100%

示例

正常返回示例

JSON格式

{
  "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%"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
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.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。