使用SynchronizeResource同步用户下的阿里云基础资源到EDAS,适用于ECS集群。
调用此接口同步ECS资源信息时,将从ECS同步全量的实例数据,当ECS实例数超过100时,不建议频繁调用此接口。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /pop/v5/resource/pop_sync_resource HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
Type | String | Query | 是 | ecs |
同步的资源类型,该参数可选的参数值为:ecs、slb、vpc、ram、all其中的一个,不支持其他格式的参数值。 |
ResourceIds | String | Query | 否 | i-bp17c***5q8x,i-bp1**5q8x |
指定的资源ID,仅当type为ecs时支持填写此参数,如有多个ID,需要以逗号分隔,一次最多同步50个资源。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | Integer | 200 |
接口请求返回的状态码 |
Data | String | PopSyncResource success |
接口请求返回的数据 |
Message | String | success |
接口请求返回的消息 |
RequestId | String | F8DFGED-K98*************** |
接口请求唯一标识符 |
Success | Boolean | true |
接口请求结果,取值如下:
|
示例
请求示例
GET /pop/v5/resource/pop\_sync\_resource HTTP/1.1
公共请求头
{
"Type": ""
}
正常返回示例
XML
格式
<Message>success</Message>
<Data>PopSyncResource success</Data>
<Code>200</Code>
<Success>true</Success>
JSON
格式
{
"Message": "success",
"Data": "PopSyncResource success",
"Code": 200,
"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')