Deploy IDC Probes for Automated Data Center Asset Discovery - Security Center - Alibaba Cloud - Security Center

Operation description

You can create an IDC probe only on servers that have the Security Center agent installed.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:AddIdcProbe

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IdcName	string	Yes	The name of the data center.	test
IpSegments	string	Yes	The settings of the CIDR block.	192.168.XX.XX/24
WinPort	string	Yes	The Windows port.	40
LinuxPort	string	Yes	The Linux port.	40
IdcRegion	string	Yes	The region ID.	Hangzhou
PeriodUnit	string	Yes	The unit of the scan interval. Valid values: day hour	day
IntervalPeriod	integer	Yes	The scan interval.	1
Uuids	string	Yes	The UUID of the server. Separate multiple UUIDs with commas (,). Note You can call the DescribeCloudCenterInstances operation to query the UUID.	076a446d-df7d-424c-bdc5-bb5dc7f1****

Response elements

Element	Type	Description	Example
	object	The response parameters.
Count	string	The total number of entries returned.	1
RequestId	string	The request ID.	D706F2DD-FF07-576B-9DD1-0B484A9B3065
AddIdcProbeFailedList	array<object>	The failure records.
	object	Details of a single failure record.
Uuid	string	The UUID of the server. Multiple UUIDs are separated by commas (,). Note You can call the DescribeCloudCenterInstances operation to query the UUID.	076a446d-df7d-424c-bdc5-bb5dc7f1****
InternetIp	string	The public IP address of the server.	95.214.XXX.XXX
InstanceName	string	The name of the server.	gl-sms-01
IdcRegion	string	The region ID.	Hangzhou
ErrorMsg	string	The error message.	The ResourceDirectoryId is invalid.
InstanceId	string	The ID of the server.	sas-yqcl2ck3****
IpSegments	string	The settings of the CIDR block.	192.168.XX.XX/24
IdcName	string	The name of the data center.	test
IntranetIp	string	The private IP address.	172.29.XXX.XXX

Examples

Success response

JSON format

{
  "Count": "1",
  "RequestId": "D706F2DD-FF07-576B-9DD1-0B484A9B3065",
  "AddIdcProbeFailedList": [
    {
      "Uuid": "076a446d-df7d-424c-bdc5-bb5dc7f1****",
      "InternetIp": "95.214.XXX.XXX",
      "InstanceName": "gl-sms-01",
      "IdcRegion": "Hangzhou",
      "ErrorMsg": "The ResourceDirectoryId is invalid.",
      "InstanceId": "sas-yqcl2ck3****",
      "IpSegments": "192.168.XX.XX/24",
      "IdcName": "test",
      "IntranetIp": "172.29.XXX.XXX"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.