ListEntities - 获取实体类型列表

获取工作空间下实体类型列表。

调试

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

授权信息

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

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

请求参数

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

工作空间

test-workspace
NextTokenstring

起始查询位置

MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK
MaxResultsinteger

最大返回数量

10
OrderBystring

排序条件

createtime
IsReversedboolean

是否逆序

false

返回参数

名称类型描述示例值
object

返回数据

HostIdstring

主机 ID

easygene.cn-beijing.aliyuncs.com
RequestIdstring

请求 ID

DA980AD0-158F-44F3-847D-5EAB96C0EB6B
NextTokenstring

下次查询的起始 Token

MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK
MaxResultsinteger

请求的最大结果数

1
TotalCountinteger

返回总个数

1
Entitiesarray<object>

实体类型数组

object

表格元素

EntityTypestring

实体类型

sample

示例

正常返回示例

JSON格式

{
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "NextToken": "MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK",
  "MaxResults": 1,
  "TotalCount": 1,
  "Entities": [
    {
      "EntityType": "sample"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter %s is invalid.无效的参数
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.缺少必要的参数
404InvalidUser.NotFoundThe specified user is not found.找不到该用户信息,请先购买开通基因云产品

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

变更历史

变更时间变更内容概要操作
暂无变更历史