edit-icon download-icon

DescribeLiveSnapshotConfig

Last Updated: Apr 16, 2018

Description

Query screenshot configuration of the domain name.

Request parameters

Parameters Type Required Example values Description
Action String Yes DescribeLiveSnapshotConfig

The name of this interface. Value: DescribeLiveSnapshotConfig

DomainName String Yes www.yourdomain.com

Your CDN domain name.

AppName String No testApp

Name of the app, which the live stream belongs to.
The * indicates the configuration targeting the domain name. If this parameter is not passed, it indicates querying all the configuration under the domain name.

Order String No asc

Sort.

  • asc: ascending.
  • desc: descending.
Default value: Asc

PageNum Integer No 1

The page number.
Default value: 1

PageSize Integer No 10

The page size.
Range: [5,30]
Default value: 10

Return Parameters

Parameters Type Example values Description
RequestId String A3136B58-5876-4168-83CA-B562781981A0

The ID of the job request.

LiveStreamSnapshotConfigList

Screenshot configuration.

  └DomainName String xxx

Your CDN domain name.

  └AppName String xxx

Name of the app, which the live stream belongs to.

  └TimeInterval Integer 10

Screenshot cycle.

  └CreateTime String 2016-05-20T01:33:38Z

Creation time.

  └OssEndpoint String oss-cn-shanghai.aliyuncs.com

OSS endpoint domain name.

  └OssBucket String test123

Name of the bucket in OSS.

  └OverwriteOssObject String test123

OSS Name of the file stored in OSS.

  └SequenceOssObject String test123

Name of the file stored in OSS.

PageNum Integer 2

The page number.

PageSize Integer 11

The page size.

Order String asc

Sort.

TotalPage Integer 10

The total number of pages.

TotalNum Integer 6

The total number of eligible items.

Example

Request exmple

  1. https://live.aliyuncs.com/?Action=DescribeLiveSnapshotConfig&DomainName=xxxxx&AppName=xxx&StreamName=xxx<Public Request Parameter>

For more information, see Public Request Parameter.

Normal return example

JSON format

  1. {
  2. "LiveStreamSnapshotConfigList":{
  3. "LiveStreamSnapshotConfig":[{
  4. "AppName":"xxx",
  5. "CreateTime":"2016-05-20T01:33:38Z",
  6. "DomainName":"xxx",
  7. "OssBucket":"bucket",
  8. "OssEndpoint":"endpoint",
  9. "OverwriteOssObject":"object",
  10. "SequenceOssObject":"object",
  11. "TimeInterval":10
  12. }]
  13. },
  14. "Order":"asc",
  15. "PageNum":1,
  16. "PageSize":10,
  17. "RequestId":"A3136B58-5876-4168-83CA-B562781981A0",
  18. "TotalNum":100,
  19. "TotalPage":10
  20. }

Exception return example

JSON format

  1. {
  2. "Code":"InternalError",
  3. "HostId":"live.aliyuncs.com",
  4. "Message":"The request processing has failed due to some unknown error.",
  5. "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
  6. }

Error code

For more information about error code of this product, see Error code.

Thank you! We've received your feedback.