更新时间:2026-09-24 GMT+08:00
分享

同步资产 - SyncResource

功能介绍

同步资产,触发资产同步任务

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/sa/resources/sync

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

是

String

参数解释:

工作空间id,用于指定操作所属的工作空间,资产查询将在该工作空间范围内进行。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

是

String

参数解释:

语言,参考值:zh-cn、en-us

约束限制:

不涉及

取值范围:

zh-cn:中文环境

en-us:英文环境

默认取值:

不涉及

X-Auth-Token

是

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

是

String

参数解释:

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

type

否

String

参数解释:

资产类型,用于指定需要同步的资产类型。

约束限制:

不涉及

取值范围:

长度为0~64个字符。

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

同步任务状态。

取值范围:

  • RUNNING:同步中

  • READY:可执行同步

task_id

String

参数解释:

同步任务ID,任务触发成功时返回。

取值范围:

长度为0~64个字符。

batch_number

String

参数解释:

同步批次号,任务触发成功时返回。

取值范围:

长度为0~32个字符。

请求示例

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/sa/resources/sync

{
  "type" : "cloudservers"
}

响应示例

状态码:200

{
  "status" : "RUNNING",
  "task_id" : "550e*****00",
  "batch_number" : "20260727103000123"
}

状态码

状态码

描述

200

同步资产返回体

错误码

请参见错误码。

相关文档