本文介绍自学习(viapi-regen)类目下的服务数据列表ListServices的语法及示例。
功能描述
通过空间ID查看服务数据详细数据。
- 您可以进入在线咨询获取在线人工帮助。
- 阿里云视觉智能开放平台视觉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 | 是 | ListServices | 系统规定参数。取值:ListServices。 |
CurrentPage | Long | 否 | 1 | 当前页数。 |
PageSize | Long | 否 | 10 | 每页数据显示条数。 |
WorkspaceId | Long | 是 | 63 | 生产空间ID,用以标识唯一生产空间。 |
Id | Long | 否 | 21 | 服务ID,用以标识唯一服务。 |
Name | Long | 否 | test | 服务名称(支持模糊搜索)。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | C3CEBC54-BCB4-0CEC-8E57-418517898C03 | 每个请求分配唯一的服务器请求ID。 |
Data | Object | 出参数据实体。 |
|
CurrentPage | Long | 1 | 当前页数。 |
PageSize | Long | 10 | 每页数据显示条数。 |
TotalPage | Long | 1 | 总页数。 |
TotalCount | Long | 2 | 总数据量。 |
Elements | Array of Object | 标注中的数据值。 |
Elements字段参数说明
字段 |
类型 |
是否必须 |
示例值 |
描述 |
---|---|---|---|---|
serviceDescription |
String |
是 |
test |
服务描述。 |
id |
Long |
是 |
21 |
服务ID。 |
gmtCreate |
Long |
是 |
1631773630000 |
创建时间。 |
serviceName |
String |
是 |
test |
服务名称。 |
status |
String |
是 |
RUNNING |
服务当前状态。服务状态:INIT(初始化),STARTING(开始运行),RUNNING(运行),START_FAIL(启动失败),STOPPING(停止运行)。 |
authorizationType |
String |
否 |
DESIGNATED_ACCOUNT |
授权类型。取值:PUBLIC(指当前服务可被任何账号调用访问),DESIGNATED_ACCOUNT(指当前服务只能被指定的账户访问)。 |
authorizedAccount |
String |
否 |
1716735326807772,1319860643305711 |
授权账号。多个账号用半角逗号(,)分隔,只在授权类型是 DESIGNATED_ACCOUNT 下生效。 |
SDK参考
阿里云视觉AI自学习类目下的服务数据列表能力推荐使用SDK调用,支持多种编程语言,调用时请选择AI类目为自学习(viapi-regen)的SDK包,文件参数通过SDK调用可支持本地文件及任意URL,具体可参见SDK总览。
示例
请求示例
http(s)://viapi-regen.cn-shanghai.aliyuncs.com/?Action=ListServices //更多关于访问域名(Endpoint)信息,请参见:https://help.aliyun.com/document_detail/143103.html
&PageSize=10
&WorkspaceId=63
&Id=21
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListServicesResponse>
<RequestId>C3CEBC54-BCB4-0CEC-8E57-418517898C03</RequestId>
<Data>
<CurrentPage>1</CurrentPage>
<PageSize>10</PageSize>
<TotalPage>1</TotalPage>
<TotalCount>2</TotalCount>
<Elements>
<serviceDescription>test</serviceDescription>
<id>21</id>
<gmtCreate>1631773630000</gmtCreate>
<serviceName>test</serviceName>
<status>RUNNING</status>
<authorizationType>DESIGNATED_ACCOUNT</authorizationType>
<authorizedAccount>1716735326807772,1319860643305711</authorizedAccount>
</Elements>
</Data>
</ListServicesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "C3CEBC54-BCB4-0CEC-8E57-418517898C03",
"Data" : {
"CurrentPage" : 1,
"PageSize" : 10,
"TotalPage" : 1,
"TotalCount" : 2,
"Elements" : [ {
"serviceDescription" : "test",
"id" : 21,
"gmtCreate" : 1631773630000,
"serviceName" : "test",
"status" : "RUNNING",
"authorizationType" : "DESIGNATED_ACCOUNT",
"authorizedAccount" : "1716735326807772,1319860643305711"
} ]
}
}
错误码
关于服务数据列表的错误码,详情请参见常见错误码。
安全声明
- 请确保上传的图片或文件来源符合相应的法律法规。
- 通过体验调试上传的临时文件有效期为1小时,在24小时后会被系统自动清理删除。