Skip to main content
API Explorer|API Explorer
Platform O&M/Automated O&M/XML Hook
POSTXML HookSince 5.2.0SynchronousAuth Required

AttachUserDefinedXmlHookScriptToVm

AttachUserDefinedXmlHookScriptToVm

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • vmInstanceUuidStringRequired

    The VM instance UUID.

  • xmlHookUuidStringRequired

    The XML Hook UUID.

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • startupStrategyString

      Optional. Whether reboot the VM instance immediately.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns an empty JSON object {}.

Endpoint

POST/zstack/v1/xmlhook/{xmlHookUuid}/vm-instances/{vmInstanceUuid}

/zstack/v1/xmlhook/{xmlHookUuid}/vm-instances/{vmInstanceUuid}

Operation ID

AttachUserDefinedXmlHookScriptToVm

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/xmlhook/{xmlHookUuid}/vm-instances/{vmInstanceUuid}' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"startupStrategy":"<startupStrategy>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{}

Change History

This API has no change history records yet.

View all change history