All Products
Search

This Product

    AnalyticDB:ModifyLogHubStatus

    Document Center

    AnalyticDB:ModifyLogHubStatus

    Last Updated:Aug 27, 2026

    Changes the status of a log shipping job.

    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

    adb:ModifyLogHubStatus

    update

    DBCluster

    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.

    Note

    To query the IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters within a region, call the DescribeDBClusters operation.

    am-uf6j8370er80m6wf3
    ProjectName

    string

    Yes

    The name of the Simple Log Service project.

    test-adb
    DeliverName

    string

    Yes

    The name of the log shipping job.

    loghub-mnp-report
    Status

    string

    Yes

    The status of the log shipping job.

    Valid values:

    • Delete

    • Pause

    • Restart

    Valid values:

    • Delete :

      Delete

    • Pause :

      Pause

    • Restart :

      Restart

    Pause
    LogStoreName

    string

    Yes

    The name of the Logstore.

    pay-notify-wx

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    0AA1F421-395B-5BC4-BDDC-762C508A952B

    Examples

    Success response

    JSON format

    {
  "RequestId": "0AA1F421-395B-5BC4-BDDC-762C508A952B"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.