All Products
Search

This Product

    CloudOps Orchestration Service:SetServiceSettings

    Document Center

    CloudOps Orchestration Service:SetServiceSettings

    Last Updated:Apr 02, 2026

    Enables or disables template execution record delivery, configures delivery destinations, and associates an Apsara DevOps enterprise ID.

    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

    oos:SetServiceSettings

    update

    *ServiceSetting

    acs:oos:{#regionId}:{#accountId}:ServiceSetting

    • oos:TLSVersion

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    DeliveryOssEnabled

    boolean

    No

    Specifies whether to enable the delivery of template execution records to Object Storage Service (OSS). The default value is false.

    false

    DeliveryOssBucketName

    string

    No

    The name of the OSS bucket.

    OssBucketName

    DeliveryOssKeyPrefix

    string

    No

    The key prefix of the OSS bucket. For example, oos/execution. To clear a previously configured prefix, set this parameter to an empty string ("").

    oos/execution

    DeliverySlsProjectName

    string

    No

    The name of the Log Service (SLS) project.

    SlsProjectName

    DeliverySlsEnabled

    boolean

    No

    Specifies whether to enable the delivery of template execution records to SLS. The default value is false.

    false

    RegionId

    string

    No

    The region ID.

    cn-hangzhou

    RdcEnterpriseId

    string

    No

    The Apsara DevOps enterprise ID.

    RdcEnterpriseId

    Response elements

    Element

    Type

    Description

    Example

    object

    The settings for delivering template execution records.

    RequestId

    string

    The request ID.

    CBEC8072-BEC2-478E-8EAE-E723BA79CF19

    ServiceSettings

    array<object>

    The service settings.

    object

    A service setting.

    DeliveryOssBucketName

    string

    The name of the OSS bucket.

    OssBucketName

    DeliveryOssKeyPrefix

    string

    The key prefix of the OSS bucket.

    oos/execution

    DeliveryOssEnabled

    boolean

    Whether the delivery of template execution records to OSS is enabled.

    true

    DeliverySlsEnabled

    boolean

    Whether the delivery of template execution records to SLS is enabled.

    false

    DeliverySlsProjectName

    string

    The name of the SLS project.

    SlsProjectName

    RdcEnterpriseId

    string

    The Apsara DevOps enterprise ID.

    RdcEnterpriseId

    ServiceAccessRdEnabled

    boolean

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "CBEC8072-BEC2-478E-8EAE-E723BA79CF19",
  "ServiceSettings": [
    {
      "DeliveryOssBucketName": "OssBucketName",
      "DeliveryOssKeyPrefix": "oos/execution",
      "DeliveryOssEnabled": true,
      "DeliverySlsEnabled": false,
      "DeliverySlsProjectName": "SlsProjectName",
      "RdcEnterpriseId": "RdcEnterpriseId",
      "ServiceAccessRdEnabled": false
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.