DocsICP FilingConsole
Documentation

BindAuthToMachine

Updated at:
Copy as MD
Product
My Favorites

Binds product authorization to specified servers.

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:BindAuthToMachine

update

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
Criteria

string

No

The search conditions for filtering assets, specified as a case-sensitive JSON string.

Note

You can filter assets by conditions such as instance ID, instance name, VPC ID, region, and public IP address. To query the supported search conditions, call the DescribeCriteria operation.

[{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}]
LogicalExp

string

No

The logical operator for multiple search conditions. The default value is OR. Valid values:

  • OR: The conditions are combined with a logical OR.

  • AND: The conditions are combined with a logical AND.

OR
BindAll

boolean

No

Indicates whether to bind the authorization to all matching assets. The default value is false. Valid values:

  • true

  • false

true
AuthVersion

integer

No

The authorization edition for the assets. Valid values:

  • 6: Anti-virus Edition

  • 5: Advanced Edition

  • 3: Enterprise Edition

  • 7: Ultimate Edition

  • 10: Value-added Service Edition

6
AutoBind

integer

No

Indicates whether to enable automatic binding. Valid values:

  • 0: Disable

  • 1: Enable

1
IsPreBind

integer

No

Indicates whether to perform a pre-binding. Valid values:

  • 0: No

  • 1: Yes

Note

If you enable pre-binding, the specified authorization edition is automatically bound to the servers after you complete the purchase.

1
PreBindOrderId

integer

No

The order ID associated with the pre-binding.

233016**0482
NtmVersion

string

No

The product edition associated with the pre-binding. Valid values:

  • level7: Anti-virus Edition

  • level3: Advanced Edition

  • level2: Enterprise Edition

  • level8: Ultimate Edition

  • level10: Value-added services only

level2
Bind

array

No

An array of UUIDs for the servers to which you want to bind the authorization.

Note

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

string

No

The UUID of the server to which you want to bind the authorization.

Note

To obtain this parameter, call the DescribeCloudCenterInstances operation.

44f9ee5a-e39d-46bb-833b-5fc2ff47****
UnBind

array

No

An array of UUIDs for the servers from which you want to unbind the authorization.

Note

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

string

No

The UUID of the server from which you want to unbind the authorization.

Note

To obtain this parameter, call the DescribeCloudCenterInstances operation.

3e3c9d79-2880-465d-9e1b-1bc2af7d****

Response elements

Element

Type

Description

Example

object

The response object.

ResultCode

integer

The status code of the binding result. Valid values:

  • 0: Success

  • 1: Invalid parameter

  • 2: Insufficient number of authorized servers

  • 3: Insufficient number of authorized cores

2
RequestId

string

The request ID. Use this ID to troubleshoot and locate issues.

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

integer

The number of servers that were successfully unbound.

1
BindCount

integer

The number of servers that were successfully bound.

1
InsufficientEcsCount

integer

The shortfall in the number of authorized servers.

1
InsufficientCoreCount

integer

The shortfall in the number of authorized cores.

1

Examples

Success response

JSON format

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

Error codes

HTTP status code

Error code

Error message

Description
400 MissingPreBindVersion The pre-bound version is missing. Missing pre-bound version information
400 -101 Invalid parameter value. Invalid parameter.
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.