All Products
Search
Document Center

Security Center:BindAuthToMachine

Last Updated:Nov 14, 2024

Binds servers to Security Center or unbinds servers from Security Center.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:BindAuthToMachineupdate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CriteriastringNo

The search conditions that are used to filter servers. The value of this parameter is in the JSON format and is case-sensitive.

Note A search condition can be an instance ID, instance name, virtual private cloud (VPC) ID, region, or public IP address. You can call the DescribeCriteria operation to query the supported search conditions.
[{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}]
LogicalExpstringNo

The logical relationship that you want to use to evaluate multiple search conditions. Default value: OR. Valid values:

  • OR****
  • AND****
OR
BindAllbooleanNo

Specifies whether to bind all servers to Security Center. Default value: false. Valid values:

  • true: yes
  • false: no
true
AuthVersionintegerNo

The edition of Security Center that is authorized to scan the asset. Valid values:

  • 6: Anti-virus
  • 5: Advanced
  • 3: Enterprise
  • 7: Ultimate
  • 10: Value-added Plan
6
AutoBindintegerNo

Specifies whether to automatically bind servers to Security Center. Valid values:

  • 0: no
  • 1: yes
1
IsPreBindintegerNo

Specifies whether to specify servers for protection when you purchase Security Center. Valid values:

  • 0: no
  • 1: yes
Note If you specify servers, the servers are automatically added to Security Center for protection after the purchase order is complete.
1
PreBindOrderIdlongNo

The ID of the order in which Security Center is purchased and servers are specified for protection.

233016**0482
NtmVersionstringNo

The edition of Security Center that you purchase in the order. Valid values:

  • level7: Anti-virus
  • level3: Advanced
  • level2: Enterprise
  • level8: Ultimate
  • level10: Value-added Plan
level2
BindarrayNo

The UUIDs of the servers that you want to bind to Security Center.

Note You must specify at least one of the Bind and UnBind parameters.
stringNo

The UUID of the server that you want to bind to Security Center.

Note You can call the DescribeCloudCenterInstances operation to query the UUIDs of servers.
44f9ee5a-e39d-46bb-833b-5fc2ff47****
UnBindarrayNo

The UUIDs of the servers that you want to unbind from Security Center.

Note You must specify at least one of the Bind and UnBind parameters.
stringNo

The UUID of the server that you want to unbind from Security Center.

Note You can call the DescribeCloudCenterInstances operation to query the UUIDs of servers.
3e3c9d79-2880-465d-9e1b-1bc2af7d****

Response parameters

ParameterTypeDescriptionExample
object
ResultCodeinteger

The status code that indicates the result. Valid values:

  • 0: The servers are bound to or unbound from Security Center.
  • 1: The values that you specified for the parameters are invalid.
  • 2: The quota for servers that can be protected is insufficient.
  • 3: The quota for cores of servers that can be protected is insufficient.
2
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

23AD0BD2-8771-5647-819E-6BA51E212F80
UnBindCountinteger

The number of unbound servers.

1
BindCountinteger

The number of bound servers.

1
InsufficientEcsCountinteger

The shortage in the quota for servers that can be protected.

1
InsufficientCoreCountinteger

The shortage in the quota for cores of servers that can be protected.

1

Examples

Sample success responses

JSONformat

{
  "ResultCode": 2,
  "RequestId": "23AD0BD2-8771-5647-819E-6BA51E212F80",
  "UnBindCount": 1,
  "BindCount": 1,
  "InsufficientEcsCount": 1,
  "InsufficientCoreCount": 1
}

Error codes

HTTP status codeError codeError messageDescription
400MissingPreBindVersionThe pre-bound version is missing.Missing pre-bound version information
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
2024-10-08The Error code has changedView Change Details
2024-03-28The Error code has changed. The request parameters of the API has changedView Change Details