Queries the components of a production studio.
Operation description
You can call the AddCasterComponent operation to add components to a production studio and then call this operation to query the components of the production studio.
QPS limit
You can call this operation up to 15 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:DescribeCasterComponents | get | *Caster acs:live:*:{#accountId}:caster/{#CasterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| CasterId | string | Yes | The ID of the production studio.
Note
You can find the ID of the production studio in the Instance ID/Name column.
| LIVEPRODUCER_POST-cn-0pp1czt**** |
| ComponentId | string | No | The component ID. If the component was added by calling the AddCasterComponent operation, check the value of the response parameter ComponentId to obtain the ID. | 21926b36-7dd2-4fde-ae25-51b5bc8e**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"Components": {
"Component": [
{
"CaptionLayerContent": {
"BorderColor": "0x000000",
"BorderWidthNormalized": 0,
"Color": "0x000000",
"FontName": "KaiTi",
"LineSpaceNormalized": 0,
"LocationId": "RV01",
"PtsOffset": 0,
"ShowSourceLan": false,
"SizeNormalized": 0.1,
"SourceLan": "cn",
"TargetLan": "cn",
"WordCountPerLine": 15,
"WordSpaceNormalized": 0,
"WordsCount": 35
},
"ComponentId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
"ComponentLayer": {
"HeightNormalized": 0.5,
"PositionNormalizeds": {
"Position": [
0.3
]
},
"PositionRefer": "topLeft",
"Transparency": 200,
"WidthNormalized": 0.5
},
"ComponentName": "component_name",
"ComponentType": "text",
"Effect": "animateV",
"ImageLayerContent": {
"MaterialId": "6cf724c6ebfd4a59b5b3cec6f10d****"
},
"LocationId": "RC01",
"TextLayerContent": {
"BorderColor": "0x000000",
"BorderWidthNormalized": 0,
"Color": "0xff0000",
"FontName": "KaiTi",
"SizeNormalized": 16,
"Text": "hello world"
}
}
]
},
"RequestId": "3be7ade8-d907-483c-b24a-0dad45******",
"Total": 3
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidCasterId.Malformed | %s |
| 401 | IllegalOperation | %s |
| 404 | InvalidCaster.NotFound | %s |
| 500 | InternalError | %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|