# 查询项目自动删除任务设置 - ShowAutoDeleteJobSettings #### 功能介绍 查询项目自动删除任务设置，包含文件的过期自动删除时间及删除规则。自动删除任务可以自动执行文件清理任务，减少管理员的工作负担，确保存储资源的有效利用。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cloudartifact/CloudArtifact_api_0008.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-cloudartifact/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsartifact:releaseRepo:getProjectInfo | Read | - | - | - | - | #### URI GET /devreposerver/v5/release/{project_id}/auto-deletion/settings 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目id，可以从调用API处获取，也可以从控制台获取。获取方式请参考[获取项目id](https://support.huaweicloud.com/api-cloudartifact/CloudArtifact_api_0015.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | x-auth-token | 是 | String | **参数解释**: 用户token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值），调用详情请参考章节。 **约束限制**: 不涉及。 **取值范围**: 字符串长度为1-100000。 **默认取值**: 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释**: 请求成功或失败状态。 **取值范围**: - success：请求成功。 - error：请求失败。 | | trace_id | String | **参数解释**: 请求id，当前请求的唯一标识。 **取值范围**: 数字及中划线(-)组成的字符串。 | | result | [ShowAutoDeleteJobSettingsResVo] object | **参数解释**: 查询仓库自动清理策略结果。 | 表4ShowAutoDeleteJobSettingsResVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | is_schedule_to_trash | Boolean | **参数解释**: 是否定时将过期文件放入回收站。 **取值范围**: - true: 启用将过期文件放入回收站。 - false: 不启用将过期文件放入回收站。 | | is_schedule_to_delete | Boolean | **参数解释**: 是否定期删除回收站过期文件。 **取值范围**: - true: 定期删除回收站过期文件。 - false: 不删除回收站过期文件。 | | file_expire_time | Integer | **参数解释**: 文件过期时间，单位day。 **取值范围**: 1-180。 | | trash_file_expire_time | Integer | **参数解释**: 回收站文件过期时间，单位day。 **取值范围**: 1-180。 | | project_id | String | **参数解释**: 项目id。 **取值范围**: 不涉及。 | | cleanRule | [cleanRule] object | **参数解释**: 清理规则。 | 表5cleanRule | 参数 | 参数类型 | 描述 | |:---|:---|:---| | skipAutoTrash | [skipAutoTrash] object | **参数解释**: 自动放入回收站时跳过文件规则。 | 表6skipAutoTrash | 参数 | 参数类型 | 描述 | |:---|:---|:---| | packageCategory | String | **参数解释**: 忽略文件类别。 **取值范围**: - null: 不忽略文件。 - prod: 忽略正式文件。 | | cleanEmptyFolder | Boolean | **参数解释**: 是否删除空文件夹。 **取值范围**: - true: 删除空文件夹。 - false: 不删除空文件夹。 | | paths | Array of strings | **参数解释**: 跳过文件路径。 **取值范围**: 不涉及。 | #### 请求示例 ``` https://artifact.example-1.com/devreposerver/v5/release/6666669620d743eca6a57881a0f006fd/auto-deletion/settings ``` #### 响应示例 **状态码：200** OK ``` { "status" : "success", "trace_id" : "76629-1718852080645-39", "result" : { "is_schedule_to_trash" : true, "is_schedule_to_delete" : true, "file_expire_time" : 90, "trash_file_expire_time" : 66, "project_id" : "6666669620d743eca6a57881a0f006fd", "cleanRule" : { "skipAutoTrash" : { "packageCategory" : "prod", "cleanEmptyFolder" : false, "paths" : [ "/a/b/c", "/d/d" ] } } } } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsartifact.v2.region.CodeArtsArtifactRegion; import com.huaweicloud.sdk.codeartsartifact.v2.*; import com.huaweicloud.sdk.codeartsartifact.v2.model.*; public class ShowAutoDeleteJobSettingsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsArtifactClient client = CodeArtsArtifactClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsArtifactRegion.valueOf("")) .build(); ShowAutoDeleteJobSettingsRequest request = new ShowAutoDeleteJobSettingsRequest(); request.withProjectId("{project_id}"); try { ShowAutoDeleteJobSettingsResponse response = client.showAutoDeleteJobSettings(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` #### Python ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsartifact.v2.region.codeartsartifact_region import CodeArtsArtifactRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsartifact.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsArtifactClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsArtifactRegion.value_of("")) \ .build() try: request = ShowAutoDeleteJobSettingsRequest() request.project_id = "{project_id}" response = client.show_auto_delete_job_settings(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` #### Go ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsartifact "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codeartsartifact.CodeArtsArtifactClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartsartifact.NewCodeArtsArtifactClient(hcClient) request := &model.ShowAutoDeleteJobSettingsRequest{} request.ProjectId = "{project_id}" response, err := client.ShowAutoDeleteJobSettings(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsArtifact/sdk?api=ShowAutoDeleteJobSettings)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cloudartifact/ErrorCode.html)。