CreateDedicatedHostCluster

更新时间:
复制 MD 格式

Creates a dedicated host group.

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

ecs:CreateDedicatedHostCluster

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID of the host group. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

DryRun

boolean

No

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including invalid AccessKey pairs, unauthorized Resource Access Management (RAM) users, and missing parameter values. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.

  • false: performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.

Default value: false.

false

Tag

array<object>

No

The tags of the host group.

object

No

The tags of the host group.

Key

string

No

The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. It can be no more than 64 characters in length, and can neither contain http:// or https:// nor start with acs: or aliyun.

TestKey

Value

string

No

The tag value. Valid values of N: 1 to 20. The tag value cannot be an empty string. It can be no more than 64 characters in length and cannot contain http:// or https://.

TestValue

ResourceGroupId

string

No

The resource group ID of the host group.

rg-bp67acfmxazb4p****

ZoneId

string

Yes

The zone ID of the host group. You can call the DescribeZones operation to query the most recent zone list.

cn-hangzhou-f

DedicatedHostClusterName

string

No

The name of the host group. It must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

This parameter is left empty by default.

myDDHCluster

Description

string

No

The description of the host group. It must be 2 to 256 characters in length, and cannot start with http:// or https://.

This parameter is left empty by default.

This-is-my-DDHCluster

Response elements

Element

Type

Description

Example

object

DedicatedHostClusterId

string

The ID of the host group.

dc-bp12wlf6bw0vz9v2****

RequestId

string

The request ID.

E2A664A6-2933-4C64-88AE-5033D003****

Examples

Success response

JSON format

{
  "DedicatedHostClusterId": "dc-bp12wlf6bw0vz9v2****",
  "RequestId": "E2A664A6-2933-4C64-88AE-5033D003****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidTagKey.Malformed The specified Tag.n.Key is not valid. The specified Tag.N.Key parameter is invalid.
400 InvalidTagValue.Malformed The specified Tag.n.Value is not valid. The specified tag value is invalid.
400 Duplicate.TagKey The Tag.N.Key contain duplicate key. The specified tag key already exists. Tag keys must be unique.
404 InvalidResourceGroup.NotFound The ResourceGroup provided does not exist in our records. The specified resource group does not exist.
404 InvalidZone.NotFound The ZoneId provided does not exist in our records. The specified zone ID does not exist.
404 QuotaExceed.Region The maximum region quota of Dedicated Host Cluster has exceeded.
404 QuotaExceed.Zone The maximum zone quota of Dedicated Host Cluster has exceeded.
404 InvalidParam.Zone The specified zone not match region.
404 InvalidRegionId.NotFound The regionId provided does not exist in our records. The RegionId provided does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.