文档

生产空间列表

更新时间:

本文介绍自学习(viapi-regen)类目下的生产空间列表ListWorkspaces的语法及示例。

功能描述

根据RegionID查看区域下生产空间的详细数据。

说明
  • 您可以进入在线咨询获取在线人工帮助。
  • 阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等,请通过钉钉群(23109592)加入阿里云视觉智能开放平台咨询群联系我们。

接入指引

1. 注册阿里云账号:打开阿里云官网,在阿里云官网右上角,单击立即注册,按照操作提示完成账号注册。

2. 开通能力:请确保您已开通自学习服务,若未开通服务请立即开通

3. 创建AccessKey:请确保您已创建AccessKey,如果您使用的是子账号AccessKey,您需要给子账号赋予AliyunVIAPIFullAccess权限,具体操作,请参见RAM授权

4. 在线调试(可选):您可以通过OpenAPI Explorer在线调试能力,查看完整的调用示例代码及SDK依赖信息,也可以下载完整的工程。

5. 开发接入步骤:

  • SDK总览中选择您要接入使用的SDK语言。
  • 在对应语言的SDK文档中找到AI类目为自学习(viapi-regen)类目的SDK包进行安装。
  • 参考文档中提供的示例代码进行适当修改后调用。

6. 客户端直接调用:该能力常用的客户端调用方式包括以下几种。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ListWorkspaces

系统规定参数。取值:ListWorkspaces。

CurrentPage Long 1

当前页数。

PageSize Long 10

每页数据显示条数。

Name String test

生产空间名称(支持模糊搜索)。

返回数据

名称

类型

示例值

描述

RequestId String 63DBD066-6374-0C1B-9E4D-9DDAEEA9CC73

每个请求分配唯一的服务器请求ID。

Data Object

出参数据实体。

CurrentPage Long 1

当前页数。

PageSize Long 10

每页数据显示条数。

TotalPage Long 4

总页数。

TotalCount Long 31

总数据量。

Elements Array of element

工作空间列表中数据集合。

Id Long 78

生产空间ID。

GmtCreate Long 1634262449000

创建时间。

Name String wyqtest

生产空间名称。

Description String wyqtest描述

生产空间描述。

Type String COMMON_CLASSIFY

生产空间类型。取值如下:

  • COMMON_CLASSIFY:通用分类
  • COMMON_DETECT:通用检测
  • COMMON_INSTANCE_SEGMENT:通用实例分割
TransferState String TRANSFER_SUCCESS

迁移至新版自学习空间的状态。TRANSFER_SUCCESS代表迁移成功,如果未迁移则不返回TransferState参数。

SDK参考

阿里云视觉AI自学习类目下的生产空间列表能力推荐使用SDK调用,支持多种编程语言,调用时请选择AI类目为自学习(viapi-regen)的SDK包,文件参数通过SDK调用可支持本地文件及任意URL,具体可参见SDK总览

示例

请求示例

http(s)://viapi-regen.cn-shanghai.aliyuncs.com/?Action=ListWorkspaces    //更多关于访问域名(Endpoint)信息,请参见:https://help.aliyun.com/document_detail/143103.html
&CurrentPage=1
&PageSize=10
&Name=test
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListWorkspacesResponse>
    <RequestId>63DBD066-6374-0C1B-9E4D-9DDAEEA9CC73</RequestId>
    <Data>
        <CurrentPage>1</CurrentPage>
        <PageSize>10</PageSize>
        <TotalPage>4</TotalPage>
        <TotalCount>31</TotalCount>
        <Elements>
            <Id>78</Id>
            <GmtCreate>1634262449000</GmtCreate>
            <Name>wyqtest</Name>
            <Description>wyqtest描述</Description>
            <Type>COMMON_CLASSIFY</Type>
            <TransferState>TRANSFER_SUCCESS</TransferState>
        </Elements>
    </Data>
</ListWorkspacesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "63DBD066-6374-0C1B-9E4D-9DDAEEA9CC73",
  "Data" : {
    "CurrentPage" : 1,
    "PageSize" : 10,
    "TotalPage" : 4,
    "TotalCount" : 31,
    "Elements" : [ {
      "Id" : 78,
      "GmtCreate" : 1634262449000,
      "Name" : "wyqtest",
      "Description" : "wyqtest描述",
      "Type" : "COMMON_CLASSIFY",
      "TransferState" : "TRANSFER_SUCCESS"
    } ]
  }
}

错误码

关于生产空间列表的错误码,详情请参见常见错误码

安全声明

  • 请确保上传的图片或文件来源符合相应的法律法规。
  • 通过体验调试上传的临时文件有效期为1小时,在24小时后会被系统自动清理删除。