用于获取云应用服务实例的屏幕截图
接口说明
请求说明
认证:请求需要携带
AliUid参数进行身份验证。实例指定方式:可以通过
RenderingInstanceIds指定要截图的实例。截图质量:通过
Quality参数可以设置截图图片的质量,默认值为 75(如果未配置),取值范围是 1 到 100。响应处理:返回结果中包含成功和失败的实例列表及其相关信息,包括下载链接以及截图完成时间等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST / HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RenderingInstanceIds |
array |
是 |
实例 ID 列表,最多 100 个 |
|
|
string |
否 |
云应用服务实例 ID |
render-a371588064324c57b7b0133a96cbd17a |
|
| Quality |
integer |
否 |
图片质量,范围 1~100 |
60 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
成功响应 |
||
| RequestId |
string |
Id of the request |
BEA5625F-8FCF-48F4-851B-CA63946DA664 |
| FailedItems |
array<object> |
截图失败实例列表。 |
|
|
object |
失败实例信息。 |
||
| RenderingInstanceId |
string |
云应用服务实例 ID |
render-072da95539d3402da90353b244191722 |
| ErrCode |
string |
失败错误码 |
Success |
| ErrMessage |
string |
失败原因信息 |
Not Applied |
| FailedCount |
integer |
失败实例数。 |
0 |
| SuccessItems |
array<object> |
成功实例列表。 |
|
|
object |
成功实例详情 |
||
| RenderingInstanceId |
string |
云应用服务实例 ID |
render-1ada8cd82783407b99fa202826fc6447 |
| DownloadUrl |
string |
截图下载地址 |
https://testts-1.oss-cn-beijing.aliyuncs.com/app/test-zip-file.zip |
| CreationTime |
string |
截图创建时间 |
2026-05-19T14:46:37+08:00 |
| SuccessCount |
integer |
成功实例数。 |
1 |
| Datatest |
object |
数据预检查结果。 |
|
| Result |
object |
预检查结果。 |
|
| SuccessCount |
integer |
成功实例数。 |
1 |
示例
正常返回示例
JSON格式
{
"RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
"FailedItems": [
{
"RenderingInstanceId": "render-072da95539d3402da90353b244191722",
"ErrCode": "Success",
"ErrMessage": "Not Applied"
}
],
"FailedCount": 0,
"SuccessItems": [
{
"RenderingInstanceId": "render-1ada8cd82783407b99fa202826fc6447",
"DownloadUrl": "https://testts-1.oss-cn-beijing.aliyuncs.com/app/test-zip-file.zip",
"CreationTime": "2026-05-19T14:46:37+08:00"
}
],
"SuccessCount": 1,
"Datatest": {
"Result": {
"SuccessCount": 1
}
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。