All Products
Search
Document Center

Security Center:AddIdcProbe

Last Updated:Aug 28, 2024

Creates an IDC probe to add assets in a data center to Security Center and manage the assets by using the Security Center console.

Operation description

Security Center allows you to create an IDC probe only on servers on which the Security Center agent is installed.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:AddIdcProbecreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IdcNamestringYes

The name of the data center.

test
IpSegmentsstringYes

The settings of the CIDR block.

192.168.XX.XX/24
WinPortstringYes

The Windows port.

40
LinuxPortstringYes

The Linux port.

40
IdcRegionstringYes

The region ID.

Hangzhou
PeriodUnitstringYes

The unit of the scan interval. Valid values:

  • day
  • hour
day
IntervalPeriodintegerYes

The scan interval.

1
UuidsstringYes

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 parameters

ParameterTypeDescriptionExample
object

The response parameters.

Countstring

The total number of entries returned.

1
RequestIdstring

The request ID.

D706F2DD-FF07-576B-9DD1-0B484A9B3065
AddIdcProbeFailedListarray<object>

The records of failure.

object

The information about a single record of failure.

Uuidstring

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****
InternetIpstring

The public IP address of the server.

95.214.XXX.XXX
InstanceNamestring

The name of the server.

gl-sms-01
IdcRegionstring

The region ID.

Hangzhou
ErrorMsgstring

The error message that is returned.

The ResourceDirectoryId is invalid.
InstanceIdstring

The ID of the server.

sas-yqcl2ck3****
IpSegmentsstring

The settings of the CIDR block.

192.168.XX.XX/24
IdcNamestring

The name of the data center.

test
IntranetIpstring

The private IP address.

172.29.XXX.XXX

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.