文档

SynchronizeResource - 同步阿里云基础资源到EDAS

更新时间:

同步用户下的阿里云基础资源到EDAS。适用于ECS集群。

接口说明

调用此接口同步 ECS 资源信息时,将从 ECS 同步全量的实例数据,当 ECS 实例数超过 100 时,不建议频繁调用此接口。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
edas:SystemBase
  • 全部资源
    *

请求语法

GET /pop/v5/resource/pop_sync_resource

请求参数

名称类型必填描述示例值
Typestring

同步的资源类型,该参数可选的参数值为:ecs、slb、vpc、all其中的一个,不支持其他格式的参数值。

ecs
ResourceIdsstring

指定的资源 ID,仅当 Type 为ecs时支持填写此参数,如有多个 ID,需要以逗号分隔,一次最多同步 50 个资源。

i-bp17c***5q8x,i-bp1**5q8x

返回参数

名称类型描述示例值
object
Codeinteger

接口请求返回的状态码。

200
Messagestring

接口请求返回的消息。

success
Datastring

接口请求返回的数据。

PopSyncResource success
RequestIdstring

接口请求唯一标识符。

F8DFGED-K98***************
Successboolean

接口请求结果,取值如下:

  • true:请求成功。

  • false:请求失败。

true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "success",
  "Data": "PopSyncResource success",
  "RequestId": "F8DFGED-K98***************",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史

注意事项

该接口在实际执行中,会遇到在 API 接口 Client 程序端在连接 API 网关超时(默认 10 秒)的情况,所以,用户在使用该接口时,须手工设置调用该接口时读取 POP API 网关返回的数据的超时时间(推荐设置为 30 秒,因 POP API 网关到接口 Server 端的服务处理时间最长即为 30 秒)。

  • 使用 Java SDK 时,Client 端代码中使用该接口时设置读取超时时间方法:
SynchronizeResourceRequest request = new SynchronizeResourceRequest();
request.setSysReadTimeout(30000);  //单位毫秒,客户端 API 接口程序等待 POP API 网关返回数据的超时时间。
request.setType("ecs");
........
  • 使用 Python SDK 时,Client 端代码中使用该接口时设置读取超时时间方法:
request = SynchronizeResourceRequest()
request.set_read_timeout(30000)
request.set_Type('ecs')
  • 本页导读 (1)
文档反馈