All Products
Search

This Product

    Security Center:ModifyPlaybookInstanceStatus

    Document Center

    Security Center:ModifyPlaybookInstanceStatus

    Last Updated:Dec 09, 2025

    Starts or stops a playbook.

    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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PlaybookUuid

    string

    Yes

    The UUID of the playbook.

    Note

    Call the DescribePlaybooks operation to obtain this parameter.

    9fcd3829-80ff-4681-be1e-xxxxxxxx
    Active

    integer

    Yes

    The status of the playbook. Valid values:

    • 1: Starts the playbook.

    • 0: Stops the playbook.

    1
    Lang

    string

    No

    The language of the request and response. The default value is zh. Valid values:

    • zh: Chinese

    • en: English

    zh

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot and locate issues.

    C2A32830-2842-5F8F-B4ED-E4783E400BBE

    Examples

    Success response

    JSON format

    {
  "RequestId": "C2A32830-2842-5F8F-B4ED-E4783E400BBE"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.