すべてのプロダクト
Search
ドキュメントセンター

:UpdateMedia

最終更新日:May 08, 2025

メディアファイルの基本情報を更新します。

使用上の注意

この操作で更新できる基本情報には、メディアファイルのタイトル、説明、カテゴリが含まれます。この操作はフルアップデートに適用されます。 特定のパラメータの値を NULL 値に置き換える場合を除き、すべてのパラメータを設定する必要があります。

QPS 制限

この操作は、1 秒あたり最大 100 回呼び出すことができます。 1 秒あたりの呼び出し数が制限を超えると、速度制限がトリガーされます。 その結果、ビジネスに影響が出る可能性があります。 この操作を呼び出すときは、制限に注意することをお勧めします。 詳細については、「QPS 制限」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストパラメータ

パラメータ タイプ 必須 説明
Action String Yes UpdateMedia

実行する操作。 値を UpdateMedia に設定します。

MediaId String Yes 3e1cd21131a94525be55acf65888****

基本情報を更新するメディアファイルの ID。 メディアファイルの ID を取得するには、ApsaraVideo Media Processing (MPS) コンソール にログインし、左側のナビゲーションウィンドウで メディア管理 > メディアリスト を選択します。

Title String No hello

メディアファイルのタイトル。 文字や数字など、複数の文字タイプがサポートされています。

  • このパラメータを指定しない場合、値は NULL です。
  • 値は UTF-8 でエンコードされ、最大 128 バイトの長さにすることができます。
Description String No example description

メディアファイルの説明。 文字や数字など、複数の文字タイプがサポートされています。

  • このパラメータを指定しない場合、値は NULL です。
  • 値は UTF-8 でエンコードされ、最大 1,024 バイトの長さにすることができます。
CoverURL String No http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/test****.jpg

メディアファイルに指定するサムネイルの格納場所。 URL を取得するには、MPS コンソール にログインし、ワークフロー > メディアバケット を選択します。 あるいは、Object Storage Service (OSS) コンソール にログインし、マイ OSS パス をクリックします。

  • 値の長さは最大 3,200 バイトです。
  • URL は RFC 2396 に準拠し、UTF-8 でエンコードされます。予約文字はパーセントエンコードされます。
CateId Long No 1

メディアファイルが属するカテゴリの ID。 値は整数である必要があります。

  • このパラメータを指定しない場合、値は NULL です。
  • 値を負にすることはできません。
Tags String No tag1,tag2

メディアファイルに追加するタグ。

  • 複数のタグはカンマ (,) で区切ります。 メディアファイルには最大 16 個のタグを指定できます。
  • 各タグの長さは最大 32 バイトです。
  • 値は UTF-8 でエンコードされます。

レスポンスパラメータ

パラメータ タイプ 説明
RequestId String 6A88246F-C91F-42BD-BABE-DB0DF993F960

リクエストの ID。

Media Object

メディアファイルの詳細情報。

CreationTime String 2016-09-14T08:30:33Z

メディアファイルが作成された日時。

CateId Long 1

メディアファイルが属するカテゴリの ID。

Height String 1080

メディアファイルの高さ。

CensorState String Initiated

動画のレビュー ステータス。有効な値:

  • Initiated: メディアファイルはアップロードされていますが、レビューされていません。
  • Pass: メディアファイルはアップロードされ、レビューに合格しています。
Tags Array of String tag1,tag2

メディアファイルのタグ。

Bitrate String 2659.326

メディアファイルのビットレート。

MediaId String 3e1cd21131a94525be55acf65888****

メディアファイルの ID。

File Object

入力ファイルに関する情報。

State String Normal

入力ファイルのステータス。有効な値:

  • Normal: 入力ファイルは正常です。
  • Deleted: 入力ファイルは削除されています。
URL String http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4

入力ファイルの URL。

PublishState String Published

メディアファイルの公開ステータス。有効な値:

  • Initiated: メディアファイルは初期状態です。
  • UnPublish: メディアファイルは公開されておらず、OSS オブジェクトの再生権限はプライベートです。
  • Published: メディアファイルは公開されており、OSS オブジェクトの再生権限はデフォルトです。
  • Deleted: メディアファイルは削除されています。
Description String example description

メディアファイルの説明。

Width String 1920

メディアファイルの幅。

Size String 2647692

メディアファイルのサイズ。

CoverURL String http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example-****.jpg

メディアサムネイルの格納場所。

RunIdList Array of String null

メディアワークフロー実行インスタンスの ID。

Duration String 7.965000

メディアファイルの再生時間。

Fps String 25.0

メディアファイルのフレームレート。

Title String hello

メディアファイルのタイトル。

Format String mov

メディアファイルのフォーマット。有効な値: mov、mp4、m4a、3gp、3g2、mj2。

リクエストの例

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=UpdateMedia
&MediaId=3e1cd21131a94525be55acf65888****
&Title=hello
&Description=example description
&CoverURL=http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/test****.jpg
&CateId=1
&Tags=tag1,tag2
&<共通リクエストパラメータ>

成功レスポンスの例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateMediaResponse>
    <RequestId>6A88246F-C91F-42BD-BABE-DB0DF993F960</RequestId>
    <Media>
        <CreationTime>2016-09-14T08:30:33Z</CreationTime>
        <CateId>1</CateId>
        <Height>1080</Height>
        <CensorState>Initiated</CensorState>
        <Tags>tag1,tag2</Tags>
        <Bitrate>2659.326</Bitrate>
        <MediaId>3e1cd21131a94525be55acf65888****</MediaId>
        <File>
            <State>Normal</State>
            <URL>http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4</URL>
        </File>
        <PublishState>Published</PublishState>
        <Description>example description</Description>
        <Width>1920</Width>
        <Size>2647692</Size>
        <CoverURL>http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example-****.jpg</CoverURL>
        <RunIdList>{"RunId":["47b42486019c4f688bf144c1a6ba****"]}</RunIdList>
        <Duration>7.965000</Duration>
        <Fps>25.0</Fps>
        <Title>hello</Title>
        <Format>mov</Format>
    </Media>
</UpdateMediaResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6A88246F-C91F-42BD-BABE-DB0DF993F960",
  "Media" : {
    "CreationTime" : "2016-09-14T08:30:33Z",
    "CateId" : 1,
    "Height" : "1080",
    "CensorState" : "Initiated",
    "Tags" : [ "tag1,tag2" ],
    "Bitrate" : "2659.326",
    "MediaId" : "3e1cd21131a94525be55acf65888****",
    "File" : {
      "State" : "Normal",
      "URL" : "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4"
    },
    "PublishState" : "Published",
    "Description" : "example description",
    "Width" : "1920",
    "Size" : "2647692",
    "CoverURL" : "http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/example-****.jpg",
    "RunIdList" : [ "{\"RunId\":[\"47b42486019c4f688bf144c1a6ba****\"]}" ],
    "Duration" : "7.965000",
    "Fps" : "25.0",
    "Title" : "hello",
    "Format" : "mov"
  }
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。