列举修正最新记录 - CollectRemediationExecutionStatusesSummary
功能介绍
列举合规规则修正最新记录。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
rms:policyAssignmentsRemediation:listRemediationExecutionStatuses
List
policyAssignmentsRemediation *
-
-
-
URI
POST /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/remediation-execution-statuses/summary
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 参数解释: 账号ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符。 默认取值: 不涉及 最大长度:36 |
| policy_assignment_id | 是 | String | 参数解释: 规则ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符 默认取值: 不涉及 最大长度:36 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 最大的返回数量。 约束限制: 不涉及 取值范围: 1~200 默认取值: 200 最小值:1 最大值:200 缺省值:200 |
| marker | 否 | String | 参数解释: 分页参数,通过上一个请求中返回的marker信息作为输入,获取当前页。 约束限制: 不涉及 取值范围: 只能由英文字母、数字及“_”、“-”、“=”、“+”、“/”组成,且长度为[4~400]个字符。 默认取值: 不涉及 最小长度:4 最大长度:400 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| resource_keys | 是 | Array of RemediationResourceKey objects | 参数解释: 合规规则最新修正记录查询条件列表。 约束限制: 不涉及 数组长度:0 - 100 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| resource_id | 是 | String | 参数解释: 资源ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字及“_”、“-”、“.”、“:”组成,且长度为[1~512]个字符 默认取值: 不涉及 最小长度:1 最大长度:512 |
| resource_provider | 是 | String | 参数解释: 云服务名称,为兼容部分合规结果中云服务名称为空的场景,可为空字符串。 约束限制: 不涉及 取值范围: 长度为[0~128]个字符 默认取值: 不涉及 最小长度:0 最大长度:128 |
| resource_type | 是 | String | 参数解释: 资源类型,为兼容部分合规结果中资源类型为空的场景,可为空字符串。 约束限制: 不涉及 取值范围: 长度为[0~128]个字符 默认取值: 不涉及 最小长度:0 最大长度:128 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| value | Array of RemediationExecutionStatus objects | 参数解释: 合规规则修正执行结果查询列表。 |
| page_info | PageInfo object | 参数解释: 分页对象。 约束限制: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_key | RemediationResourceKey object | 参数解释: 合规规则修正记录查询条件详情。 约束限制: 不涉及 |
| invocation_time | String | 参数解释: 补救执行的开始时间。 取值范围: 不涉及 |
| state | String | 参数解释: 合规规则修正执行的状态。 取值范围: |
| message | String | 参数解释: 合规规则修正执行的信息。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_id | String | 参数解释: 资源ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字及“_”、“-”、“.”、“:”组成,且长度为[1~512]个字符 默认取值: 不涉及 最小长度:1 最大长度:512 |
| resource_provider | String | 参数解释: 云服务名称,为兼容部分合规结果中云服务名称为空的场景,可为空字符串。 约束限制: 不涉及 取值范围: 长度为[0~128]个字符 默认取值: 不涉及 最小长度:0 最大长度:128 |
| resource_type | String | 参数解释: 资源类型,为兼容部分合规结果中资源类型为空的场景,可为空字符串。 约束限制: 不涉及 取值范围: 长度为[0~128]个字符 默认取值: 不涉及 最小长度:0 最大长度:128 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| current_count | Integer | 参数解释: 当前页的资源数量。 约束限制: 不涉及 取值范围: 0-200 默认取值: 不涉及 最小值:0 最大值:200 |
| next_marker | String | 参数解释: 下一页的marker。 约束限制: 不涉及 取值范围: 长度为[4~400]个字符 默认取值: 不涉及 最小长度:4 最大长度:400 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误消息内容。 取值范围: 不涉及 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误消息内容。 取值范围: 不涉及 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误消息内容。 取值范围: 不涉及 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误消息内容。 取值范围: 不涉及 |
请求示例
查询指定资源最新的修正执行记录
POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/remediation-execution-statuses/summary
{
"resource_keys" : [ {
"resource_id" : "resource_id_1",
"resource_provider" : "resource_provider_1",
"resource_type" : "resource_type_1"
}, {
"resource_id" : "resource_id_2",
"resource_provider" : "resource_provider_2",
"resource_type" : "resource_type_2"
} ]
} 响应示例
状态码:200
操作成功。
{
"value" : [ {
"resource_key" : {
"resource_id" : "resource_id1",
"resource_provider" : "resource_provider1",
"resource_type" : "resource_type1"
},
"invocation_time" : "2024-01-17T09:39:19Z",
"state" : "SUCCEEDED",
"message" : "Execution success."
}, {
"resource_key" : {
"resource_id" : "resource_id1",
"resource_provider" : "resource_provider2",
"resource_type" : "resource_type2"
},
"invocation_time" : "2024-01-17T09:41:20Z",
"state" : "FAILED",
"message" : "You do not have the permission to invoke functionGraph."
} ],
"page_info" : {
"current_count" : 2,
"next_marker" : null
}
} SDK代码示例
SDK代码示例如下。
查询指定资源最新的修正执行记录
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.config.v1.region.ConfigRegion; import com.huaweicloud.sdk.config.v1.*; import com.huaweicloud.sdk.config.v1.model.*; import java.util.List; import java.util.ArrayList; public class CollectRemediationExecutionStatusesSummarySolution { 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 GlobalCredentials() .withAk(ak) .withSk(sk); ConfigClient client = ConfigClient.newBuilder() .withCredential(auth) .withRegion(ConfigRegion.valueOf("<YOUR REGION>")) .build(); CollectRemediationExecutionStatusesSummaryRequest request = new CollectRemediationExecutionStatusesSummaryRequest(); request.withPolicyAssignmentId("{policy_assignment_id}"); RemediationExecutionStatusesSummaryRequestBody body = new RemediationExecutionStatusesSummaryRequestBody(); List<RemediationResourceKey> listbodyResourceKeys = new ArrayList<>(); listbodyResourceKeys.add( new RemediationResourceKey() .withResourceId("resource_id_1") .withResourceProvider("resource_provider_1") .withResourceType("resource_type_1") ); listbodyResourceKeys.add( new RemediationResourceKey() .withResourceId("resource_id_2") .withResourceProvider("resource_provider_2") .withResourceType("resource_type_2") ); body.withResourceKeys(listbodyResourceKeys); request.withBody(body); try { CollectRemediationExecutionStatusesSummaryResponse response = client.collectRemediationExecutionStatusesSummary(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()); } } } |
查询指定资源最新的修正执行记录
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkconfig.v1 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 = GlobalCredentials(ak, sk) client = ConfigClient.new_builder() \ .with_credentials(credentials) \ .with_region(ConfigRegion.value_of("<YOUR REGION>")) \ .build() try: request = CollectRemediationExecutionStatusesSummaryRequest() request.policy_assignment_id = "{policy_assignment_id}" listResourceKeysbody = [ RemediationResourceKey( resource_id="resource_id_1", resource_provider="resource_provider_1", resource_type="resource_type_1" ), RemediationResourceKey( resource_id="resource_id_2", resource_provider="resource_provider_2", resource_type="resource_type_2" ) ] request.body = RemediationExecutionStatusesSummaryRequestBody( resource_keys=listResourceKeysbody ) response = client.collect_remediation_execution_statuses_summary(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
查询指定资源最新的修正执行记录
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/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 := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := config.ConfigClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := config.NewConfigClient(hcClient) request := &model.CollectRemediationExecutionStatusesSummaryRequest{} request.PolicyAssignmentId = "{policy_assignment_id}" var listResourceKeysbody = []model.RemediationResourceKey{ { ResourceId: "resource_id_1", ResourceProvider: "resource_provider_1", ResourceType: "resource_type_1", }, { ResourceId: "resource_id_2", ResourceProvider: "resource_provider_2", ResourceType: "resource_type_2", }, } request.Body = &model.RemediationExecutionStatusesSummaryRequestBody{ ResourceKeys: listResourceKeysbody, } response, err := client.CollectRemediationExecutionStatusesSummary(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 操作成功。 |
| 400 | 输入参数不合法。 |
| 403 | 鉴权失败。 |
| 404 | 资源未找到 |
| 500 | 服务器内部错误。 |
错误码
请参见错误码。