すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:DescribeLiveSnapshotConfig

    ドキュメントセンター

    ApsaraVideo Live:DescribeLiveSnapshotConfig

    最終更新日:Jun 22, 2026

    ストリーミングドメイン配下のスナップショット設定を照会します。

    操作説明

    まずストリーミングドメインを取得し、その後このオペレーションを呼び出してストリーミングドメイン配下のスナップショット設定を照会します。

    QPS 制限

    このオペレーションのシングルユーザーQPS 制限は1 秒あたり100 回です。制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。必要に応じてこのオペレーションを呼び出してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    live:DescribeLiveSnapshotConfig

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DomainName

    string

    必須

    ストリーミングドメイン。

    example.com
    AppName

    string

    任意

    ライブストリームが属するアプリケーションの名前。

    liveApp****
    PageNum

    integer

    任意

    ページ番号。デフォルト値：1。

    1
    PageSize

    integer

    任意

    1ページあたりのエントリ数。有効な値：5～30。デフォルト値：10。

    10
    Order

    string

    任意

    ソート順序。有効な値：

    • asc（デフォルト）：昇順。

    • desc：降順。

    列挙値:

    • asc :

      昇順。

    • desc :

      降順。

    asc

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PageNum

    integer

    ページ番号。

    2
    RequestId

    string

    リクエストID。

    A3136B58-5876-4168-83CA-B562781981A0
    Order

    string

    ソート順序。

    asc
    TotalPage

    integer

    合計ページ数。

    10
    PageSize

    integer

    1ページあたりのエントリ数。

    11
    TotalNum

    integer

    指定された条件を満たすエントリの合計数。

    6
    LiveStreamSnapshotConfigList

    object

    LiveStreamSnapshotConfig

    array<object>

    スナップショット設定のリスト。

    object

    OverwriteOssObject

    string

    上書きモードで保存されるスナップショットの命名フォーマット。新しいスナップショットが前のスナップショットを上書きすることを意味します。

    {liveApp****}/{liveStream****}.jpg
    TimeInterval

    integer

    スナップショットがキャプチャされる間隔。単位：秒。

    10
    AppName

    string

    ライブストリームが属するアプリケーションの名前。

    liveApp****
    CreateTime

    string

    構成が作成された時間。時間は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠します。時間は UTC で表示されます。

    2016-05-20T01:33:38Z
    OssBucket

    string

    Object Storage Service (OSS) バケットの名前。

    liveBucket****
    DomainName

    string

    メインのストリーミングドメイン。

    example.com
    Callback

    string

    スナップショットキャプチャに関する通知を受信するために使用されるコールバック URL。

    https://learn.aliyundoc.com
    SequenceOssObject

    string

    シーケンスで保存されるスナップショットの命名フォーマット。新しいスナップショットが前のスナップショットを上書きしないことを意味します。

    snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp}.jpg
    OssEndpoint

    string

    OSS バケットのエンドポイント。

    cn-oss-****.aliyuncs.com

    例

    成功レスポンス

    JSONJSON

    {
  "PageNum": 2,
  "RequestId": "A3136B58-5876-4168-83CA-B562781981A0",
  "Order": "asc",
  "TotalPage": 10,
  "PageSize": 11,
  "TotalNum": 6,
  "LiveStreamSnapshotConfigList": {
    "LiveStreamSnapshotConfig": [
      {
        "OverwriteOssObject": "{liveApp****}/{liveStream****}.jpg",
        "TimeInterval": 10,
        "AppName": "liveApp****",
        "CreateTime": "2016-05-20T01:33:38Z",
        "OssBucket": "liveBucket****",
        "DomainName": "example.com",
        "Callback": "https://learn.aliyundoc.com",
        "SequenceOssObject": "snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp}.jpg",
        "OssEndpoint": "cn-oss-****.aliyuncs.com"
      }
    ]
  }
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。