# 获取老化策略详情 - ShowInstanceRetentionPolicy #### 功能介绍 获取老化策略详情 #### 接口约束 无 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-swr2/swr_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-swr2/swr_02_0131.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | swr:repository:getRetentionPolicy | Read | repository \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - | #### URI GET /v2/{project_id}/instances/{instance_id}/namespaces/{namespace_name}/retention/policies/{policy_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID | | instance_id | 是 | String | 企业仓库实例ID | | namespace_name | 是 | String | 命名空间名称 | | policy_id | 是 | Integer | 老化策略ID | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | 老化策略ID | | algorithm | String | 算法 | | rules | Array of [RetentionRuleResponseBody] objects | 匹配规则 | | trigger | [TriggerConfig] object | 触发方式 | | enabled | Boolean | 是否开启策略 | | name | String | 策略名称 | | namespace_id | Integer | 命名空间ID | | namespace_name | String | 命名空间名 | 表4RetentionRuleResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | 镜像老化策略ID | | priority | Integer | 预留字段，目前只支持0 | | disabled | Boolean | 是否关闭此条规则 | | action | String | 预留字段，目前只支持retain | | template | String | 规则模板类型，值为：latestPulledN，latestPushedK，nDaysSinceLastPush，nDaysSinceLastPull | | params | Map\ | 保留方式的参数，配套template使用，可参考请求示例 | | tag_selectors | Array of [RetentionSelector] objects | 制品版本选择器，目前只支持长度为1 | | scope_selectors | Map\\> | 制品仓库选择器，目前只支持repository且长度为1 | | repo_scope_mode | String | repo选择模式，前端使用，可选regular、selection | 表5RetentionSelector | 参数 | 参数类型 | 描述 | |:---|:---|:---| | kind | String | 匹配类型，目前只支持doublestar | | decoration | String | 选择器匹配类型 制品仓库选择器可选repoMatches，repoMatches制品版本可选matches，excludes | | pattern | String | 选择器匹配样式，最大长度512。支持正则表达式，正则表达式规则可填写如 nginx-\* ，{repo1，repo2} 等，其中： - ： 匹配不包含 '/' 的任何字段。 \*\*：匹配包含 '/' 的任何字段。 ? ：匹配任何单个非 '/' 的字符。 {选项1,选项2,...}：同时匹配多个选项。 | | extras | String | 预留字段 | 表6TriggerConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 触发类型，老化规则只支持manual(手动)、scheduled(定时+手动)；同步策略支持manual(手动)、scheduled(定时+手动)、event_based(事件触发+手动);镜像签名支持manual(手动)、event_based(事件触发+手动) | | trigger_settings | [TriggerSetting] object | 触发设置，只有type为scheduled的时候，才需要设置 | 表7TriggerSetting | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cron | String | 定时设置，cron格式描述 '\* \* \* \* \* \*'。cron 基于 UTC 时间。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：403** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：404** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误信息 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | #### 请求示例 ``` GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/namespaces/{namespace_name}/retention/policies/{policy_id} ``` #### 响应示例 **状态码：200** 查询成功 ``` { "id" : 36, "algorithm" : "or", "rules" : [ { "id" : 0, "priority" : 0, "disabled" : false, "action" : "retain", "template" : "latestPushedK", "params" : { "latestPushedK" : 5 }, "tag_selectors" : [ { "kind" : "doublestar", "decoration" : "matches", "pattern" : "**", "extras" : "" } ], "scope_selectors" : { "repository" : [ { "kind" : "doublestar", "decoration" : "repoMatches", "pattern" : "**", "extras" : "" } ] }, "repo_scope_mode" : "regular" } ], "trigger" : { "type" : "scheduled", "trigger_settings" : { "cron" : "0 5 5 * * ?" } }, "enabled" : true, "name" : "test-create", "namespace_id" : 95, "namespace_name" : "ccc" } ``` #### 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.swr.v2.region.SwrRegion; import com.huaweicloud.sdk.swr.v2.*; import com.huaweicloud.sdk.swr.v2.model.*; public class ShowInstanceRetentionPolicySolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); SwrClient client = SwrClient.newBuilder() .withCredential(auth) .withRegion(SwrRegion.valueOf("")) .build(); ShowInstanceRetentionPolicyRequest request = new ShowInstanceRetentionPolicyRequest(); request.withInstanceId("{instance_id}"); request.withNamespaceName("{namespace_name}"); request.withPolicyId({policy_id}); try { ShowInstanceRetentionPolicyResponse response = client.showInstanceRetentionPolicy(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 huaweicloudsdkswr.v2.region.swr_region import SwrRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkswr.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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = SwrClient.new_builder() \ .with_credentials(credentials) \ .with_region(SwrRegion.value_of("")) \ .build() try: request = ShowInstanceRetentionPolicyRequest() request.instance_id = "{instance_id}" request.namespace_name = "{namespace_name}" request.policy_id = {policy_id} response = client.show_instance_retention_policy(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" swr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/swr/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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := swr.SwrClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := swr.NewSwrClient(hcClient) request := &model.ShowInstanceRetentionPolicyRequest{} request.InstanceId = "{instance_id}" request.NamespaceName = "{namespace_name}" request.PolicyId = int32({policy_id}) response, err := client.ShowInstanceRetentionPolicy(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SWR/sdk?api=ShowInstanceRetentionPolicy)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | | 400 | 错误的请求 | | 401 | 鉴权失败 | | 403 | 禁止访问 | | 404 | 未找到资源 | | 500 | 内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-swr2/ErrorCode.html)。