全部产品
Search
文档中心

智能接入网关:ListEnterpriseCode - 查询企业码列表

更新时间:Mar 03, 2024

调用ListEnterpriseCode接口查询企业码信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:ListEnterpriseCodeList
  • EnterpriseCode
    acs:smartag:{#regionId}:{#accountId}:enterprisecode/*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-shanghai
EnterpriseCodestring

要查询的企业码。

12P**
IsDefaultboolean

是否只查询默认企业码。取值:

  • true:是。
  • false(默认值):否。
false
NextTokenstring

分批次查询时,下一次查询的 Token。

caeba0bbb2be03f84eb48b699f0*****
MaxResultsinteger

分批次查询时每次显示的条目数。

取值范围:1~100。默认值:10

2

返回参数

名称类型描述示例值
object

查询结果。

TotalCountinteger

总条目数。

2
NextTokenstring

分批次查询时,下一次查询的 Token。

caeba0bbb2be03f84eb48b699f0*****
RequestIdstring

请求 ID。

1A57EF84-D587-4CF9-B0C8-307488BF52C9
MaxResultsinteger

分批次查询时每次显示的条目数。

2
EnterpriseCodesobject []

企业码信息。

IsDefaultboolean

是否为默认企业码:

  • true:是。
  • false:否。
true
EnterpriseCodestring

企业码。

12P**

示例

正常返回示例

JSON格式

{
  "TotalCount": 2,
  "NextToken": "caeba0bbb2be03f84eb48b699f0*****",
  "RequestId": "1A57EF84-D587-4CF9-B0C8-307488BF52C9",
  "MaxResults": 2,
  "EnterpriseCodes": [
    {
      "IsDefault": true,
      "EnterpriseCode": "12P**"
    }
  ]
}

错误码

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