Skip to main content
API Explorer|API Explorer
Resource Center/Hardware/Host Operations
POSTHost OperationsSince 4.7.11SynchronousAuth Required

AllocateHostResource

AllocateHostResource

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    The resource UUID.

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • strategyStringRequired

      The resource allocation policy.

    • sceneStringRequired

      The scene type.

    • vcpuintRequired

      The number of vCPUs that need to be allocated to a VM instance.

    • memSizeLong

      Optional. The memory size of the vNUMA node.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • nameStringRequired

    The resource name.

  • uuidStringRequired

    The resource UUID.

  • vCPUPinListRequired

    The CPU pinning.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The short description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

Endpoint

POST/zstack/v1/hosts/{uuid}/allocate-resource

/zstack/v1/hosts/{uuid}/allocate-resource

Operation ID

AllocateHostResource

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/hosts/{uuid}/allocate-resource' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"strategy":"<strategy>","scene":"<scene>","vcpu":1,"memSize":1},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "name": "example", "uuid": "f7bae73b9874344b8766dfcdda48ad6e", "vCPUPin": [ { "vCPU": "0", "pCPU": "13" } ] }

Change History

This API has no change history records yet.

View all change history