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

查询商品列表

功能介绍

查询商品列表

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/products

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

偏移量,表示从此偏移量开始查询。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

每页显示的条目数量。

取值范围:

1-100

默认取值:

10

sort_key

String

排序字段,支持的排序方式有:

  • 按创建时间排序:create_time

  • 按更新时间排序:update_time

  • 按资产排序:asset_order

sort_dir

String

排序方式。

  • asc:升序

  • desc:降序

默认asc升序。

create_until

String

过滤创建时间<=输入时间的记录。

create_since

String

过滤创建时间>=输入时间的记录。

name

String

按名称模糊查询。

tag

String

按标签模糊查询。

state

String

按状态查询,多状态使用英文逗号分割。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取。

响应消息头中X-Subject-Token的值。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

格式为(YYYYMMDD'T'HHMMSS'Z')。

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息。

X-App-UserId

String

第三方用户ID。不允许输入中文。

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID

表5 响应Body参数

参数

参数类型

描述

count

Integer

参数解释

商品信息总数

取值范围:

0-2147483647

products

Array of ProductDetailInfo objects

商品信息列表

表6 ProductDetailInfo

参数

参数类型

描述

product_id

String

商品ID

name

String

商品名称

description

String

商品描述

tags

Array of strings

标签。单个标签16字节,多个用逗号分隔,最多50个。

cover

ProductCoverDetailInfo object

商品封面信息

text_list

Array of ProductTextInfo objects

文本列表

asset_list

Array of ProductMediaDetailInfo objects

素材资产列表

create_time

String

商品创建时间,格式遵循:RFC 3339。 例 “2020-07-30T10:43:17Z”。

update_time

String

商品更新时间,格式遵循:RFC 3339。 例 “2020-07-30T10:43:17Z”。

state

String

商品状态枚举

  • ACTIVED:已激活

  • UNACTIVED:未激活

  • BLOCK: 被冻结,商品不可用

  • DELETED:已删除

表7 ProductCoverDetailInfo

参数

参数类型

描述

asset_id

String

资产ID

cover_url

String

封面图片路径。

thumbnail_url

String

缩略图路径。

表8 ProductTextInfo

参数

参数类型

描述

title

String

文本标题

text

String

文本

表9 ProductMediaDetailInfo

参数

参数类型

描述

asset_id

String

资产ID

asset_type

String

资产类型

  • IMAGE:图片

  • VIDEO:视频

  • AUDIO:音频

order

Integer

参数解释

资产次序。不设置或者0表示按照加入时间先后排序。业务上将次序最靠前的图片设置为商品封面。

取值范围:

0-300

默认取值:

0

asset_name

String

资产名称。

asset_state

String

资产状态。

cover_url

String

封面图片路径。

thumbnail_url

String

缩略图路径。

main_url

String

缩略图路径。

状态码: 400

表10 响应Body参数

参数

参数类型

描述

BadRequest

AnyType

请求传参异常,包含错误码及对应描述。

状态码: 500

表11 响应Body参数

参数

参数类型

描述

InternalServiceError

AnyType

内部服务错误。

请求示例

GET https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/products

响应示例

状态码: 200

查询商品列表请求成功

{
  "count" : 1,
  "products" : [ {
    "product_id" : "24bad716-87b1-45e5-8912-6102f7693265",
    "name" : "会议",
    "description" : "会议",
    "tags" : [ "华为" ],
    "create_time" : "2021-09-30T10:43:17Z",
    "update_time" : "2021-10-30T12:30:35Z",
    "state" : "CREATING"
  } ]
}

状态码: 400

请求传参异常,包含错误码及对应描述。

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

状态码: 500

内部服务错误。

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

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
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.metastudio.v1.region.MetaStudioRegion;
import com.huaweicloud.sdk.metastudio.v1.*;
import com.huaweicloud.sdk.metastudio.v1.model.*;


public class ListProductsSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        MetaStudioClient client = MetaStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(MetaStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        ListProductsRequest request = new ListProductsRequest();
        try {
            ListProductsResponse response = client.listProducts(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkmetastudio.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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = MetaStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListProductsRequest()
        response = client.list_products(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := metastudio.NewMetaStudioClient(
        metastudio.MetaStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListProductsRequest{}
	response, err := client.ListProducts(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询商品列表请求成功

400

请求传参异常,包含错误码及对应描述。

500

内部服务错误。

错误码

请参见错误码

相关文档