Synchronizing Agent Information of Resources in On-premises IDCs
Function
This API is used to synchronize Agent information from on-premises IDCs when you manage such resources in COC.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
coc:instance:syncResources
Write
-
-
-
-
URI
POST /v1/other-resources/uniagent/sync
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| resource_infos | No | Array of resource_infos objects | Definition Select the resource information corresponding to the resource to be synchronized. Constraints N/A Range The list contains 1 to 100 items. Default value N/A |
| vendor | No | String | Definition Cloud vendor. Constraints N/A Range Default value The value is a string. It contains 1 to 64 characters. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| region_id | No | String | Definition ID of the region to which the resource belongs. Constraints N/A Range The value is a string. It contains 0 to 64 characters. Default value N/A |
| resource_id | No | String | Definition ID of the resource selected by the user. Constraints N/A Range The value is a string. It contains 36 characters. Default value N/A |
| id | No | String | Definition ID of the resource stored in COC-CMDB. Constraints N/A Range N/A Default value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| data | String | Definition Task ID. Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. Range The value is a string. It contains 8 to 36 characters. |
| error_msg | String | Definition Error description. Range The value is a string. It contains 2 to 512 characters. |
Example Requests
Synchronize the agent information of resources in on-premises IDCs.
POST https://{Endpoint}/v1/other-resources/uniagent/sync
{
"resource_infos" : [ {
"region_id" : "string",
"agent_id" : null,
"id" : "67e24aa6acb0972ab0272e97"
} ]
} Example Responses
Status code: 200
{
"data" : "ed0e78ed-91ee-4ef1-ad9f-39daea9cd352"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Agent information of resources in on-premises IDCs is synchronized. |
| 400 | Failed to synchronize the agent information of resources in on-premises IDCs. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot