查询仓库或文件的审计日志信息 - ShowAudit
功能介绍
根据仓库ID分页查询仓库或文件的审计日志信息,可用于追溯操作记录和定位问题等。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| codeartsartifact:repository:read | Read | - | - | - | - |
URI
GET /cloudartifact/v5/{tenant_id}/{project_id}/{module}/{repo}/audit
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| tenant_id | 是 | String | 参数解释: 租户id,获取方式请参考获取账号ID约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为8到32个字符。 默认取值: 不涉及。 |
| project_id | 是 | String | 参数解释: 项目id,可以从调用API处获取,也可以从控制台获取。获取方式请参考获取项目id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| module | 是 | String | 参数解释: 模块。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| repo | 是 | String | 参数解释: 仓库id,格式为{region}_{domainId}_{format}_{sequence}。使用查询仓库详情,不会去统计仓库下的制品数量接口的响应体中"name"参数的值作为此参数的值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| user_id | 否 | String | 参数解释: 用户id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| instance_id | 否 | String | 参数解释: 该参数已废弃。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| page_num | 否 | Integer | 参数解释: 分页查询的页数。 约束限制: (page_num - 1) * page_size < 2147483647。 取值范围: 1-2147483647。 默认取值: 1。 |
| page_size | 否 | Integer | 参数解释: 分页查询的每页数据量。 约束限制: (page_num - 1) * page_size < 2147483647。 取值范围: 1-100。 默认取值: 10。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| x-auth-token | 是 | String | 参数解释: 用户token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值),调用详情请参考章节。 约束限制: 不涉及。 取值范围: 字符串长度为1-100000。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 请求成功或失败状态。 取值范围: |
| trace_id | String | 参数解释: 请求id,当前请求的唯一标识。 取值范围: 数字及中划线(-)组成的字符串。 |
| result | AuditResult object | 参数解释: 审计日志信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| auditInfoList | Array of AuditDO objects | 参数解释: 审计日志列表。 取值范围: 不涉及。 |
| total | Integer | 参数解释: 审计日志条数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 操作id。 取值范围: 不涉及。 |
| module | String | 参数解释: 操作模块。 取值范围: 不涉及。 |
| operation | String | 参数解释: 操作类型。 取值范围: 不涉及。 |
| time | String | 参数解释: 操作时间。 取值范围: 不涉及。 |
| info | String | 参数解释: 操作组件所属仓库id。 取值范围: 不涉及。 |
| data | String | 参数解释: 操作组件相对路径。 取值范围: 不涉及。 |
| reason | String | 参数解释: 操作原因。 取值范围: 不涉及。 |
| userAgent | String | 参数解释: 操作人客户端类型。 取值范围: 不涉及。 |
| operator | String | 参数解释: 操作人。 取值范围: 不涉及。 |
| operatorNickName | String | 参数解释: 操作人昵称。 取值范围: 不涉及。 |
| operatorTenantName | String | 参数解释: 操作人租户名。 取值范围: 不涉及。 |
请求示例
查询仓库或文件的审计日志信息
https://artifact.example-1.com/cloudartifact/v5/00000000000000000000000000000000/00000000000000000000000000000000/file/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_1_108/audit?page_num=1&page_size=5
响应示例
状态码:200
OK
{
"status" : "success",
"trace_id" : "143002-1701222589443-431",
"result" : {
"auditInfoList" : [ {
"id" : "2271182",
"module" : "file",
"operation" : "upload",
"time" : "2023/10/27 15:46:19",
"info" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_1_108",
"data" : "1/1/1/1-1-1.jar",
"reason" : null,
"userAgent" : "Apache-HttpClient/4.5.13 (Java/1.8.0_232)",
"operator" : "devcloud_devcloud_y00226182_01",
"ipSource" : "10.172.180.79"
} ],
"total" : 1
}
} SDK代码示例
SDK代码示例如下。
Java
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 | 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 ShowAuditSolution { 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("<YOUR REGION>")) .build(); ShowAuditRequest request = new ShowAuditRequest(); request.withTenantId("{tenant_id}"); request.withProjectId("{project_id}"); request.withModule("{module}"); request.withRepo("{repo}"); try { ShowAuditResponse response = client.showAudit(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
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 | # 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("<YOUR REGION>")) \ .build() try: request = ShowAuditRequest() request.tenant_id = "{tenant_id}" request.project_id = "{project_id}" request.module = "{module}" request.repo = "{repo}" response = client.show_audit(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
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 | 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("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartsartifact.NewCodeArtsArtifactClient(hcClient) request := &model.ShowAuditRequest{} request.TenantId = "{tenant_id}" request.ProjectId = "{project_id}" request.Module = "{module}" request.Repo = "{repo}" response, err := client.ShowAudit(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。