ListBrands - 查询品牌列表

更新时间:
复制 MD 格式

获取品牌列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eiam:ListBrands

list

*Brand

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

NextToken

string

查询凭证(Token)。

NTxxxxxexample

PreviousToken

string

查询上一页凭证(Token)。

PTxxxxxexample

MaxResults

integer

分页查询时每页行数。

20

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A

TotalCount

integer

列表总条数目。

100

NextToken

string

本次调用返回的查询凭证(Token)值。

NTxxxexample

PreviousToken

string

本次调用返回的查询凭证(Token)值。

PTxxxexample

MaxResults

integer

分页查询时每页行数。

20

Brands

array<object>

品牌数据列表。

object

品牌数据。

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

BrandId

string

品牌 ID。

brand_xxxx

BrandName

string

品牌名称。

Custom Brand

BrandType

string

品牌类型。

枚举值:

  • system_init :

    系统初始化

  • user_custom :

    用户自定义

user_custom

Status

string

品牌状态。

枚举值:

  • disabled :

    禁用

  • enabled :

    启用

enabled

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "PreviousToken": "PTxxxexample",
  "MaxResults": 20,
  "Brands": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "BrandId": "brand_xxxx",
      "BrandName": "Custom Brand",
      "BrandType": "user_custom",
      "Status": "enabled"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情