查询项目下的制品存储容量信息 - ShowProjectStorageInfo

功能介绍

查询项目下的制品存储容量，包含已使用存储容量和文件数量等信息。在项目管理中，可以使用该接口监控项目下的制品存储情况，以确保资源的有效利用。

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
codeartsartifact:releaseRepo:getProjectInfo	Read	-	-	-	-

URI

GET /devreposerver/v5/{project_id}/storage

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目id，可以从调用API处获取，也可以从控制台获取。获取方式请参考获取项目id。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
parent_id	否	String	参数解释：查询目录id。可根据目录id查询目录下制品存储容量信息，不填写可查询整个项目下制品存储容量信息。使用查询文件/项目列表接口的响应体中"id"参数的值作为查询目录id的值。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
x-auth-token	是	String	参数解释: 用户token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值），调用详情请参考章节。约束限制: 不涉及。取值范围: 字符串长度为1-100000。默认取值: 不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
status	String	参数解释: 请求成功或失败状态。取值范围: success：请求成功。 error：请求失败。
trace_id	String	参数解释: 请求id，当前请求的唯一标识。取值范围: 数字及中划线(-)组成的字符串。
result	StorageInfoDOV5 object	参数解释: 存储容量信息。取值范围: 不涉及。

表5 StorageInfoDOV5
参数	参数类型	描述
used_space_length	Long	参数解释: 使用空间（字节）。取值范围: 不涉及。
used_space	String	参数解释: 使用空间（带单位）。取值范围: 不涉及。
files_count	Long	参数解释: 文件数量。取值范围: 不涉及。

请求示例

查询项目下的制品存储容量信息

https://artifact.example-1.com/devreposerver/v5/f132b62084774001b84c294c0eef27f2/storage

响应示例

状态码：200

{
  "status" : "success",
  "trace_id" : "d35d637cf19846b497dbdb3e2771072b",
  "result" : {
    "used_space_length" : 363,
    "used_space" : "363.0B",
    "files_count" : 2
  }
}

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.codeartsartifact.v2.region.CodeArtsArtifactRegion;
import com.huaweicloud.sdk.codeartsartifact.v2.*;
import com.huaweicloud.sdk.codeartsartifact.v2.model.*;


public class ShowProjectStorageInfoSolution {

    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();
        ShowProjectStorageInfoRequest request = new ShowProjectStorageInfoRequest();
        request.withProjectId("{project_id}");
        try {
            ShowProjectStorageInfoResponse response = client.showProjectStorageInfo(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 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 = ShowProjectStorageInfoRequest()
        request.project_id = "{project_id}"
        response = client.show_project_storage_info(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"
    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.ShowProjectStorageInfoRequest{}
	request.ProjectId = "{project_id}"
	response, err := client.ShowProjectStorageInfo(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}
 
 
  