All Products
Search
Document Center

CloudOps Orchestration Service:SetServiceSettings

Last Updated:Oct 14, 2024

Enables or disables the feature of delivering template execution records and sets the storage location.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
oos:SetServiceSettingsupdate
  • ServiceSetting
    acs:oos:{#regionId}:{#accountId}:ServiceSetting
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DeliveryOssEnabledbooleanNo

Whether to enable OSS delivery.

false
DeliveryOssBucketNamestringNo

The name of OSS bucket to deliver.

OssBucketName
DeliveryOssKeyPrefixstringNo

The key prefix of OSS to deliver.

oos/execution
DeliverySlsProjectNamestringNo

The name of SLS project to deliver.

SlsProjectName
DeliverySlsEnabledbooleanNo

Whether to enable SLS delivery.

false
RegionIdstringNo

The region ID.

cn-hangzhou
RdcEnterpriseIdstringNo

The id of RDC Enterprise.

RdcEnterpriseId

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CBEC8072-BEC2-478E-8EAE-E723BA79CF19
ServiceSettingsarray<object>

The information of service settings.

ServiceSettingobject
DeliveryOssBucketNamestring

The name of OSS bucket to deliver.

OssBucketName
DeliveryOssKeyPrefixstring

The key prefix of OSS to deliver.

oos/execution
DeliveryOssEnabledboolean

Whether to enable OSS delivery.

true
DeliverySlsEnabledboolean

Whether to enable SLS delivery.

false
DeliverySlsProjectNamestring

The name of SLS project to deliver.

SlsProjectName
RdcEnterpriseIdstring

The id of RDC Enterprise.

RdcEnterpriseId

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history