Querying Audit Logs about Repository or File
Function
Query audit logs about a repository or file.
Calling Method
For details, see Calling APIs.
URI
GET /cloudartifact/v5/{tenant_id}/{project_id}/{module}/{repo}/audit
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
tenant_id |
Yes |
String |
Definition: Tenant ID. Constraints: The value can contain 8 to 32 characters. Only letters and digits are supported. Value range: N/A Default value: None |
project_id |
Yes |
String |
Definition: Project ID. It can be obtained by calling an API or from the console. For details about how to obtain the project ID, see Obtaining a Project ID (CloudArtifact_api_0015.xml). Constraints: The value can contain 32 characters. Only letters and digits are supported. Value range: N/A Default value: None |
module |
Yes |
String |
Definition: Module. Constraints: N/A Value range: file repository Default value: None |
repo |
Yes |
String |
Definition: Repository ID. The format is {region}{domainId}{format}_{sequence}. You can find the repository ID on the general page of your self-hosted repos. It is the string located between the last two slashes (/) in the repository URL. Constraints: The region and domainId in the repository ID must be valid values. The valid values of format are npm, go, pypi, rpm, composer, maven, debian, conan, nuget, docker2, cocoapods, and ohpm. The upper limit of sequence varies depending on the package. Value range: N/A Default value: None |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
user_id |
No |
String |
Definition: User ID. Constraints: N/A Value range: N/A Default value: None |
instance_id |
No |
String |
Definition: Instance ID. Constraints: N/A Value range: N/A Default value: None |
page_num |
No |
Integer |
Definition: Number of pages in a pagination query. Constraints: N/A Value range: 1–2,147,483,647 Default value: 1 |
page_size |
No |
Integer |
Definition: Number of records on each page during the pagination query. Constraints: N/A Value range: 1–100 Default value: 10 |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
status |
String |
Definition: Request status. Value range: success: The request is successful. error: The request fails. |
trace_id |
String |
Definition: Request ID, which uniquely identifies the current request. Value range: A string of digits and hyphens (-). |
result |
AuditResult object |
Definition: Audit log information. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
auditInfoList |
Array of AuditDO objects |
Definition: Audit log list. Value range: N/A |
total |
Integer |
Definition: Number of audit logs. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Operation ID. Value range: N/A id |
module |
String |
Definition: Operation module. Value range: N/A |
operation |
String |
Definition: Operation type. Value range: N/A |
time |
String |
Definition: Operation time. Value range: N/A |
info |
String |
Definition: Operation information. Value range: N/A |
data |
String |
Definition: Operation data. Value range: N/A |
reason |
String |
Definition: Cause. Value range: N/A |
userAgent |
String |
Definition: Client type of the operator. Value range: N/A |
operator |
String |
Definition: Operator. Value range: N/A |
operatorNickName |
String |
Definition: Operator name. Value range: N/A |
operatorTenantName |
String |
Definition: Tenant name of the operator. Value range: N/A |
ipSource |
String |
Definition: IP address of the operator. Value range: N/A |
Example Requests
Query audit logs about a repository or file.
https://artifact.cn-south-1.myhuaweicloud.com/cloudartifact/v5/00000000000000000000000000000000/00000000000000000000000000000000/file/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_1_108/audit?page_num=1&page_size=5
Example Responses
Status code: 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 Sample Code
The SDK sample code is as follows.
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 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsartifact.NewCodeArtsArtifactClient( codeartsartifact.CodeArtsArtifactClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) 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) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot