全部产品
Search
文档中心

运维编排服务:SetServiceSettings - 开启或关闭模板执行记录投递功能

更新时间:Oct 13, 2022

开启或关闭模板执行记录的投递功能,以及投递存储地点。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oos:SetServiceSettingsWRITE
  • OOS
    acs:oos:{#regionId}:{#accountId}:*

请求参数

名称类型必填描述示例值
DeliveryOssEnabledboolean

是否开启向OSS投递模板执行记录功能,默认为false。

false
DeliveryOssBucketNamestring

OSS存储空间名称。

OssBucketName
DeliveryOssKeyPrefixstring

OSS存储空间目录,如"oos/execution",传入""表示不需要目录,若之前设置过再次设置不需要目录可通过传入""清空。

oos/execution
DeliverySlsProjectNamestring

SLS的项目名称。

SlsProjectName
DeliverySlsEnabledboolean

是否开启向SLS投递模板执行记录功能,默认为false。

false
RegionIdstring

地域ID。

cn-hangzhou
RdcEnterpriseIdstring

云效企业ID。

RdcEnterpriseId

返回参数

名称类型描述示例值
object

模板执行记录的投递功能设置信息.

RequestIdstring

请求ID。

CBEC8072-BEC2-478E-8EAE-E723BA79CF19
ServiceSettingsarray

投递功能配置详情

object

设置详情。

DeliveryOssBucketNamestring

OSS存储空间名称

OssBucketName
DeliveryOssKeyPrefixstring

OSS存储空间目录

oos/execution
DeliveryOssEnabledboolean

是否开启了向OSS投递模板执行记录功能

true
DeliverySlsEnabledboolean

是否开启了向SLS投递模板执行记录功能

false
DeliverySlsProjectNamestring

SLS的项目名称

SlsProjectName
RdcEnterpriseIdstring

云效企业ID

RdcEnterpriseId

示例

请求示例

http(s)://[Endpoint]/?Action=SetServiceSettings
&DeliveryOssEnabled=false
&DeliveryOssBucketName=OssBucketName
&DeliveryOssKeyPrefix=oos/execution
&DeliverySlsProjectName=SlsProjectName
&DeliverySlsEnabled=false
&RegionId=cn-hangzhou
&RdcEnterpriseId=RdcEnterpriseId
&公共请求参数

正常返回示例

JSON格式

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

XML格式

<SetServiceSettingsResponse>
    <RequestId>CBEC8072-BEC2-478E-8EAE-E723BA79CF19</RequestId>
    <ServiceSettings>
        <DeliveryOssBucketName>OssBucketName</DeliveryOssBucketName>
        <DeliveryOssKeyPrefix>oos/execution</DeliveryOssKeyPrefix>
        <DeliveryOssEnabled>true</DeliveryOssEnabled>
        <DeliverySlsEnabled>false</DeliverySlsEnabled>
        <DeliverySlsProjectName>SlsProjectName</DeliverySlsProjectName>
        <RdcEnterpriseId>RdcEnterpriseId</RdcEnterpriseId>
    </ServiceSettings>
</SetServiceSettingsResponse>

错误码

访问错误中心查看更多错误码。