更新时间:2024-08-06 GMT+08:00
分享

通过checksum搜索文件

功能介绍

通过checksum搜索文件

调用方法

请参见如何调用API

URI

GET /cloudartifact/v5/search/checksum

表1 Query参数

参数

是否必选

参数类型

描述

checksum

String

参数解释:

文件校验和,可在页面文件详细信息概览中获取,文件校验和的MD5, SHA-1, SHA-256, SHA-512任意值。

约束限制:

不涉及。

取值范围:

只能使用英文字符、数字,字符串长度32、40、64、128。

默认取值:

不涉及。

page_no

Integer

参数解释:

页码。

约束限制:

不涉及。

取值范围:

最小值1。

默认取值:

1

page_size

Integer

参数解释:

每页大小。

约束限制:

不涉及。

取值范围:

最小值1,最大值100。

默认取值:

10

format

String

参数解释:

仓库类型。

约束限制:

不涉及。

取值范围:

允许的类型为: maven2|npm|go|pypi|rpm|composer|debian|conan|nuget|docker2|cocoapods|ohpm。

默认取值:

不涉及。

in_project

String

参数解释:

是否在项目中,值为true,project_id有值时,查询指定项目数据;project_id无值时,查询当前账号所有项目数据。值为false或不传值时查询当前租户下未关联项目的仓库数据。

约束限制:

不涉及。

取值范围:

true or false。

默认取值:

不涉及。

project_id

String

参数解释:

项目id,对应"需求管理 CodeArts Req"项目唯一标识,私有依赖库首页地址栏url https://{host}/cloudartifact/project/{project_id}/repository中project_id变量的值。

约束限制:

参数in_project值为true值时此参数生效。

取值范围:

只能使用小写英文字符及数字,字符串长度为32位。

默认取值:

不涉及。

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求成功、失败状态。

取值范围:

success: 请求成功。

error:请求失败。

trace_id

String

参数解释:

请求id,当前请求唯一标识。

取值范围:

数字及中划线(-)组成的字符串。

result

Array of objects

参数解释:

请求返回结果,接口不同,返回不同。

取值范围:

根据不同接口有不同范围。

请求示例

通过checksum搜索文件

https://artifact.cn-south-1.myhuaweicloud.com/cloudartifact/v5/search/checksum?checksum=eb05a9df1e3403a5f54e03de073a6ce6&page_no=1&page_size=10&in_project=true&project_id=e2ee90487d6349dd944a5767225f6f55&format=pypi

响应示例

状态码: 200

OK

{
  "status" : "success",
  "trace_id" : "143006-1701220804200-277",
  "result" : [ {
    "name" : "mod.txt",
    "relativePath" : "1/1/mod.txt",
    "createdBy" : null,
    "createdUserName" : "devcloud_devcloud_y00226182_01",
    "created" : null,
    "modified" : "2023-11-29T09:19:13.711+08:00",
    "repo" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_pypi_40",
    "repoName" : "testpypi",
    "displayName" : null,
    "oldRepoId" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_pypi_40",
    "repoType" : "pypi"
  } ]
}

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
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 SearchByChecksumSolution {

    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();
        SearchByChecksumRequest request = new SearchByChecksumRequest();
        try {
            SearchByChecksumResponse response = client.searchByChecksum(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
# 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 = SearchByChecksumRequest()
        response = client.search_by_checksum(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
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.SearchByChecksumRequest{}
	response, err := client.SearchByChecksum(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档