Skip to main content
API Explorer|API Explorer
Platform O&M/Automated O&M/Script Library
PUTScript LibrarySince 5.2.0SynchronousAuth Required

ExecuteGuestVmScript

ExecuteGuestVmScript

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

  • executeguestvmscriptObjectRequired

    executeguestvmscript request body object.

    • vmInstanceUuidsListRequired

      The VM instance UUID.

    • scriptTimeoutInteger

      Optional. The timeout period.

    • logPathString

      Optional. The log path.

    • systemTagsList

      Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

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

Endpoint

PUT/zstack/v1/scripts/{uuid}/actions

/zstack/v1/scripts/{uuid}/actions

Operation ID

ExecuteGuestVmScript

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/scripts/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"executeguestvmscript":{"vmInstanceUuids":["<vmInstanceUuids>"],"scriptTimeout":1,"logPath":"<logPath>","systemTags":["<systemTags>"]},"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "e5dc4c630a7138a692e45ad372c5ba17", "scriptUuid": "da3f23e42960342b81c8d7f4cbceeb69", "recordName": "202308111633_script1", "scriptTimeout": 30, "status": "Running", "executor": "admin", "executionCount": 20, "version": 1, "startTime": "Sep 23, 2024 11:50:03 AM", "endTime": "Sep 23, 2024 11:50:03 AM" } }

Change History

This API has no change history records yet.

View all change history