{
  "name": "car",
  "display_name": "应用云渲染",
  "description": "应用云渲染 API 为您提供请求调度并发资源的能力。",
  "domain": "other",
  "api_version": "2022-01-10",
  "endpoint": "car.tencentcloudapi.com",
  "actions": [
    {
      "name": "ApplyConcurrent",
      "description": "本接口用于申请并发。接口超时时间：20秒。",
      "status": "online",
      "parameters": [
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）",
          "example": "cg_user"
        },
        {
          "name": "UserIp",
          "type": "string",
          "required": true,
          "description": "用户IP，用户客户端的公网IP，用于就近调度",
          "example": "125.127.178.228"
        },
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目ID",
          "example": "cap-abcdefgh"
        },
        {
          "name": "ApplicationVersionId",
          "type": "string",
          "required": false,
          "description": "应用版本ID。如果请求应用的当前版本，可以不用填写该字段。如果请求应用的其它版本时，才需要通过该字段来指定应用的版本。",
          "example": "ver-1a2b3c4d"
        },
        {
          "name": "ApplicationId",
          "type": "string",
          "required": false,
          "description": "应用ID。如果是独享项目，将忽略该参数，使用项目绑定的应用。如果是共享项目，使用该参数来指定应用。",
          "example": "app-a1b2c3d4"
        }
      ],
      "required": [
        "UserId",
        "UserIp",
        "ProjectId"
      ]
    },
    {
      "name": "CreateSession",
      "description": "本接口用于创建会话。接口超时时间：5秒。",
      "status": "online",
      "parameters": [
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）",
          "example": "cg_user"
        },
        {
          "name": "UserIp",
          "type": "string",
          "required": true,
          "description": "用户IP，用户客户端的公网IP，用于就近调度",
          "example": "125.127.178.228"
        },
        {
          "name": "ClientSession",
          "type": "string",
          "required": false,
          "description": "客户端session信息，从SDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空",
          "example": "eyJhYmMiOjEyM30="
        },
        {
          "name": "RunMode",
          "type": "string",
          "required": false,
          "description": "云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。",
          "example": "RunWithoutClient"
        },
        {
          "name": "ApplicationParameters",
          "type": "string",
          "required": false,
          "description": "应用启动参数。 如果请求的是多应用共享项目，此参数生效； 如果请求的是关闭预启动的单应用独享项目，此参数生效； 如果请求的是开启预启动的单应用独享项目，此参数失效。 注意：在此参数生效的情况下，将会被追加到控制台应用或项目配置的启动参数的后面。 例如，对于某关闭预启动的单应用独享项目，若在控制台中项目配置的启动参数为bar=0，而ApplicationParameters\ufffd...",
          "example": "StartFor=1"
        },
        {
          "name": "HostUserId",
          "type": "string",
          "required": false,
          "description": "【多人互动】房主用户ID，在多人互动模式下为必填字段。 如果该用户是房主，HostUserId需要和UserId保持一致； 如果该用户非房主，HostUserId需要填写房主的HostUserId。",
          "example": "host_user_id"
        },
        {
          "name": "Role",
          "type": "string",
          "required": false,
          "description": "【多人互动】角色。 Player：玩家（可通过键鼠等操作应用） Viewer：观察者（只能观看，无法操作）",
          "example": "Player"
        }
      ],
      "required": [
        "UserId",
        "UserIp"
      ]
    },
    {
      "name": "DescribeConcurrentCount",
      "description": "获取并发计数",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": false,
          "description": "项目ID",
          "example": "cap-abcdefgh"
        },
        {
          "name": "ApplicationCategory",
          "type": "string",
          "required": false,
          "description": "应用类别（DESKTOP: 桌面端，MOBILE：移动端）",
          "example": "DESKTOP"
        }
      ],
      "required": []
    },
    {
      "name": "DestroySession",
      "description": "销毁会话。如果该会话开启了云端推流，那么销毁会话时会结束云端推流。",
      "status": "online",
      "parameters": [
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）",
          "example": "639d069e-a13a-437a-a10b-64a33ecb8e78"
        }
      ],
      "required": [
        "UserId"
      ]
    },
    {
      "name": "StartPublishStream",
      "description": "开始云端推流。云端推流 codec 根据客户端（SDK）能力来自动选择，默认优先顺序为 H265、H264、VP8、VP9。",
      "status": "online",
      "parameters": [
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "唯一用户身份标识，由业务方自定义，平台不予理解。（UserId将作为StreamId进行推流，比如绑定推流域名为abc.livepush.myqcloud.com，那么推流地址为rtmp://abc.livepush.myqcloud.com/live/UserId?txSecret=xxx\u0026txTime=xxx）",
          "example": "abc123"
        },
        {
          "name": "PublishStreamArgs",
          "type": "string",
          "required": false,
          "description": "推流参数，推流时携带自定义参数。",
          "example": "bar=1\u0026foo=2"
        }
      ],
      "required": [
        "UserId"
      ]
    },
    {
      "name": "StartPublishStreamWithURL",
      "description": "开始云端推流到指定URL。云端推流 codec 根据客户端（SDK）能力来自动选择，默认优先顺序为 H265、H264、VP8、VP9。该推流方式需要单独计费，详细计费方式请查看[指定地址推流费用说明](https://cloud.tencent.com/document/product/1547/72168#98ac188a-d122-4caf-88be-05268ecefdf6)",
      "status": "online",
      "parameters": [
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "唯一用户身份标识，由业务方自定义，平台不予理解。",
          "example": "abc123"
        },
        {
          "name": "PublishStreamURL",
          "type": "string",
          "required": true,
          "description": "推流地址，仅支持rtmp协议。",
          "example": "rtmp://live.stream.com/publish"
        }
      ],
      "required": [
        "UserId",
        "PublishStreamURL"
      ]
    },
    {
      "name": "StopPublishStream",
      "description": "停止云端推流",
      "status": "online",
      "parameters": [
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）",
          "example": "abc123"
        }
      ],
      "required": [
        "UserId"
      ]
    }
  ]
}