文档

DescribeRenderingInstance - 查询云应用服务实例详细信息

更新时间:

查询一个云应用服务实例的详细信息。

调试

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

授权信息

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

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

请求参数

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

云应用服务实例 ID

render-9f8c57355d224ad7beaf95e145f22111

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

BEA5625F-8FCF-48F4-851B-CA63946DA664
RenderingInstanceIdstring

云应用服务实例 ID

render-9f8c57355d224ad7beaf95e145f22111
CreationTimestring

实例创建时间

2024-05-07T02:27:06Z
SystemInfoobject

系统信息,包括分辨率等

Resolutionstring

分辨率。取值:

  • 1920*864

  • 1080*1920

  • 1920*1080

  • 720*1280

  • 2400*1080

  • 1080*2400

  • 1280*720

  • 864*1920

1920*1080
Frequencyinteger

实例刷新率,单位 HZ

60
RenderingStatusobject

实例操作状态

Statusstring

实例操作状态,取值范围,

  1. Preparing:初始化准备中
  2. Rebooting:重启中
  3. Resetting:重置中
  4. Working:工作中,属于终态
  5. Failure:操作失败,属于终态
Working
LatestActionstring

实例最近一次操作动作名

MigrateLocalData
Descriptionstring

状态描述

工作中
ConfigInfoobject

实例配置信息

NetworkConfigobject

出/入方向带宽限速。单位 Mb/s。

MaxIngressBandwidthinteger

入方向最大限流,单位 Mb/s。0 表示无限流配置

100
MaxEgressBandwidthinteger

出方向最大限流,单位 Mb/s。0 表示无限流配置

100
BandwidthStatusstring

带宽生效状态,取值:

  1. waiting:生效中
  2. success:已生效
  3. failed:生效失败
success
UpdateTimestring

更新时间

2023-08-17T09:54:35Z
Configurationarray<object>

已配置的真机仿真模块信息列表

object

已配置的真机仿真模块属性信息

ModuleNamestring

真机仿真功能模块名,取值范围包括,

  1. ctl:控制模块
  2. prop:属性模块
  3. location:定位模块
  4. battery:电池模块
  5. network:网络模块
  6. bluetooth:蓝牙模块
  7. sim:SIM 卡模块
  8. display:设备模块
  9. system:基础模块
location
Attributesarray<object>

属性列表

object

属性信息

Namestring

属性名

lon
Valueany

属性值

100
Hostnamestring

云应用服务实例域名/出口 IP

cn-xxx.ecr.aliyuncs.com
PortMappingsarray<object>

端口映射信息列表

object

端口映射信息

ExternalPortstring

外网端口或端口段,如 22。若为端口段,以正斜线(/)隔开起始端口,例如 10/20。

10013/10020
InternalPortstring

内网端口或端口段,端口与外网端口一一对应。若为端口段,以正斜线(/)隔开起始端口,例如 10/20。

49008/49015

示例

正常返回示例

JSON格式

{
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "RenderingInstanceId": "render-9f8c57355d224ad7beaf95e145f22111",
  "CreationTime": "2024-05-07T02:27:06Z",
  "SystemInfo": {
    "Resolution": "1920*1080",
    "Frequency": 60
  },
  "RenderingStatus": {
    "Status": "Working",
    "LatestAction": "MigrateLocalData",
    "Description": "工作中"
  },
  "ConfigInfo": {
    "NetworkConfig": {
      "MaxIngressBandwidth": 100,
      "MaxEgressBandwidth": 100,
      "BandwidthStatus": "success",
      "UpdateTime": "2023-08-17T09:54:35Z"
    },
    "Configuration": [
      {
        "ModuleName": "location",
        "Attributes": [
          {
            "Name": "lon",
            "Value": "100"
          }
        ]
      }
    ]
  },
  "Hostname": "cn-xxx.ecr.aliyuncs.com",
  "PortMappings": [
    {
      "ExternalPort": "10013/10020",
      "InternalPort": "49008/49015"
    }
  ]
}

错误码

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