获取业务列表 GetProductList--云游戏-火山引擎

文档中心

立即注册

导航

获取业务列表 GetProductList

最近更新时间：2025.01.20 15:42:50首次发布时间：2024.04.19 13:53:05

查询当前账号下已创建的业务列表。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=GetProductList&Version=2023-03-18

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetProductList`	接口名称。当前 API 的名称为 `GetProductList`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。
GameType	String	否	`android`	游戏平台标识，缺省情况下查询全部平台业务。取值如下所示： `android`：云游戏手游业务 `pc`：云游戏端游业务
LastToken	String	否	`IKHKIIJL`	查询位置标记，用于在分页查询时指示从何处开始获取下一页的数据。您可将上一次查询时返回的`LastToken`值作为本次查询的入参，以便在分页查询中获取后续数据。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
Total	Long	`1`	查询到的业务总数。
ProductList	Array of ProductList	`-`	业务信息列表。单次查询最多返回 10 条，您可多次调用本接口进行分页查询。
LastToken	String	`IMHHIIJL`	查询位置标记，您可以在下一次查询时传入该值。

ProductList

参数	类型	示例值	描述
ProductId	String	`9810***9872103932`	业务 ID。
ProductName	String	`app1`	业务名称。

请求示例

GET https://open.volcengineapi.com?Action=GetProductList&Version=2023-03-18&GameType=android&LastToken=IKHKIIJL

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetProductList",
        "Version": "2023-03-18",
        "Service": "vegame",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 1,
        "ProductList": [
            {
                "ProductId": "9810***9872103932",
                "ProductName": "app1"
            }
        ],
        "LastToken": "IMHHIIJL"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。