调用ListTenants实现租户列表查询_人工智能平台 PAI(PAI)-阿里云帮助中心

展示阿里云账号下的iTAG租户。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /openapi/api/v1/tenants

请求参数

名称	类型	必填	描述	示例值
PageSize	integer	否	分页查询时设置的每页显示的租户数量，默认为 20。	20
PageNumber	integer	否	租户列表的页码。起始值为 1，默认为 1。	1

返回参数

名称	类型	描述	示例值
	object	执行结果。
Code	integer	返回编码，默认为 0，表示执行正常。	0
Message	string	请求的返回信息。	success
RequestId	string	请求 ID。	90ABA848-AD74-1F6E-84BC-4182A7F1****
Details	string	详情。	-
Success	boolean	请求是否成功，可能值： true：请求成功。 false：请求失败。	true
PageNumber	integer	返回查询的租户列表的页码。	1
PageSize	integer	返回每页显示的租户数量。	20
TotalPage	integer	租户列表总页数。	2
TotalCount	integer	租户总数。	22
Tenants	array	租户列表。
	SimpleTenant	租户。
ErrorCode	string	返回的错误码。	""

示例

正常返回示例

JSON格式

{
  "Code": 0,
  "Message": "success",
  "RequestId": "90ABA848-AD74-1F6E-84BC-4182A7F1****",
  "Details": "-",
  "Success": true,
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPage": 2,
  "TotalCount": 22,
  "Tenants": [
    {
      "Creator": {
        "UserId": 0,
        "AccountType": "ALIYUN",
        "AccountNo": "166***9980757310",
        "UserName": "txdemo@test.aliyunid.com",
        "Role": "ADMIN"
      },
      "GmtCreateTime": "2021-07-07 16:09:20",
      "GmtModifiedTime": "2021-07-07 16:09:20",
      "TenantId": "GA***W134",
      "TenantName": "demo",
      "UUID": "paiworkspace-0001",
      "Description": "这是一个测试租户",
      "Role": "ADMIN",
      "Modifier": {
        "UserId": 0,
        "AccountType": "ALIYUN",
        "AccountNo": "166***9980757310",
        "UserName": "txdemo@test.aliyunid.com",
        "Role": "ADMIN"
      }
    }
  ],
  "ErrorCode": "\"\""
}

错误码

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