{
  "name": "vod",
  "display_name": "云点播",
  "description": "介绍如何使用API对云点播进行操作，如事件通知、视频处理、媒资管理等。",
  "domain": "other",
  "api_version": "2024-07-18",
  "endpoint": "vod.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateIncrementalMigrationStrategy",
      "description": "创建增量迁移策略。",
      "status": "online",
      "parameters": [
        {
          "name": "SubAppId",
          "type": "integer",
          "required": true,
          "description": "点播[专业版](/document/product/266/115396)[应用](/document/product/266/14574) ID。",
          "example": "1020304056"
        },
        {
          "name": "BucketId",
          "type": "string",
          "required": true,
          "description": "策略生效的存储桶 ID。",
          "example": "bucketid123"
        },
        {
          "name": "StrategyName",
          "type": "string",
          "required": true,
          "description": "增量迁移策略名称，名称长度不超过100个字符，允许的字符为：`中文、英文、0-9、_、-`。",
          "example": "strategy_name"
        },
        {
          "name": "OriginType",
          "type": "string",
          "required": true,
          "description": "源站类型。取值有： HTTP：HTTP 源。",
          "example": "HTTP"
        },
        {
          "name": "HttpOriginConfig",
          "type": "object",
          "required": false,
          "description": "增量迁移 HTTP 回源源站配置，当 OriginType 取值 `HTTP` 时必填。",
          "example": "无",
          "children": [
            {
              "name": "OriginInfo",
              "type": "object",
              "required": true,
              "description": "回源源站信息。",
              "example": "无",
              "children": [
                {
                  "name": "EndpointInfo",
                  "type": "object",
                  "required": true,
                  "description": "增量迁移源站地址信息。",
                  "example": "无",
                  "children": [
                    {
                      "name": "Endpoint",
                      "type": "string",
                      "required": true,
                      "description": "地址信息，支持域名或 IP 地址。",
                      "example": "example.com"
                    },
                    {
                      "name": "StandbyEndpointSet",
                      "type": "array",
                      "required": false,
                      "description": "备份地址信息。",
                      "example": "[\"standby.com\",\"standby2.com\"]",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "FileInfo",
                  "type": "object",
                  "required": false,
                  "description": "增量迁移源站文件信息。",
                  "example": "无",
                  "children": [
                    {
                      "name": "PrefixConfig",
                      "type": "object",
                      "required": false,
                      "description": "文件前缀配置。",
                      "example": "无"
                    },
                    {
                      "name": "SuffixConfig",
                      "type": "object",
                      "required": false,
                      "description": "文件后缀配置。",
                      "example": "无"
                    },
                    {
                      "name": "FixedFileConfig",
                      "type": "object",
                      "required": false,
                      "description": "固定文件配置。",
                      "example": "无"
                    }
                  ]
                }
              ]
            },
            {
              "name": "OriginParameter",
              "type": "object",
              "required": true,
              "description": "回源参数。",
              "example": "无",
              "children": [
                {
                  "name": "HttpHeaderInfo",
                  "type": "object",
                  "required": true,
                  "description": "HTTP 头部透传信息。",
                  "example": "无",
                  "children": [
                    {
                      "name": "HeaderFollowMode",
                      "type": "string",
                      "required": true,
                      "description": "Http Header 透传模式。取值有： FOLLOW_ALL：透传所有头部信息； FOLLOW_PART：透传部分头部信息； IGNORE_PART：忽略部分头部信息。参数必填。",
                      "example": "FOLLOW_ALL"
                    },
                    {
                      "name": "FollowHttpHeaderKeySet",
                      "type": "array",
                      "required": false,
                      "description": "需透传 Header Key 集合，仅当 HeaderFollowMode 取值 `FOLLOW_PART` 时需要填充。",
                      "example": "[\"Host\"]",
                      "item_type": "string"
                    },
                    {
                      "name": "NewHttpHeaderSet",
                      "type": "array",
                      "required": false,
                      "description": "新增 Header 键值对集合。",
                      "example": "无",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "Protocol",
                  "type": "string",
                  "required": false,
                  "description": "回源协议。取值有： HTTP：强制 HTTP； HTTPS：强制 HTTPS； FOLLOW：跟随请求协议。若不填，默认取值 `FOLLOW`。",
                  "example": "HTTP"
                },
                {
                  "name": "QueryStringFollowMode",
                  "type": "string",
                  "required": false,
                  "description": "请求参数透传模式。取值有： FOLLOW：全部透传； IGNORE：忽略，全部不透传。 默认取值 `FOLLOW`。",
                  "example": "FOLLOW"
                },
                {
                  "name": "HttpRedirectCode",
                  "type": "integer",
                  "required": false,
                  "description": "重定向的 HTTP Code，目前仅支持 `301`，`302` 和 `307`。默认取值 `302`。",
                  "example": "302"
                },
                {
                  "name": "OriginRedirectionFollowMode",
                  "type": "string",
                  "required": false,
                  "description": "源站重定向跟随模式。取值有： FOLLOW：跟随源站重定向； IGNORE：忽略源站重定向。 默认取值 `FOLLOW` 跟随源站重定向，即源站返回 `3xx` 时，会默认跟随至对应源站拉取数据。",
                  "example": "FOLLOW"
                }
              ]
            },
            {
              "name": "Mode",
              "type": "string",
              "required": false,
              "description": "回源模式。取值有： SYNC：同步回源； ASYNC：异步回源。若不填，默认取 `SYNC` 同步回源。",
              "example": "SYNC"
            },
            {
              "name": "OriginCondition",
              "type": "object",
              "required": false,
              "description": "回源条件。",
              "example": "无",
              "children": [
                {
                  "name": "HttpStatusCode",
                  "type": "integer",
                  "required": false,
                  "description": "触发回源条件的 HTTP Code。若不填充，默认取值 `404`。",
                  "example": "404"
                },
                {
                  "name": "Prefix",
                  "type": "string",
                  "required": false,
                  "description": "触发回源条件的对象键前缀。",
                  "example": "prefix_test"
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "SubAppId",
        "BucketId",
        "StrategyName",
        "OriginType"
      ]
    },
    {
      "name": "CreateStorage",
      "description": "该接口用于为专业版应用创建存储桶。 注： - 本接口仅用于专业版应用； - 客户创建点播专业版应用时，系统默认为客户开通了部分地域的存储，用户如果需要开通其它地域的存储，可以通过该接口进行开通； - 通过 [DescribeStorageRegions](https://cloud.tencent.com/document/product/266/72480) 接口可以查询到所有存储地域及已经开通存储桶的地域。",
      "status": "online",
      "parameters": [
        {
          "name": "SubAppId",
          "type": "integer",
          "required": true,
          "description": "点播专业版[应用](/document/product/266/14574) ID。",
          "example": "1020304056"
        },
        {
          "name": "StorageRegion",
          "type": "string",
          "required": true,
          "description": "存储地域，必须是系统支持地域。 通过 [DescribeStorageRegions](https://cloud.tencent.com/document/product/266/72480) 接口可以查询到所有存储地域及已经开通存储桶的地域。",
          "example": "ap-shanghai"
        },
        {
          "name": "StorageName",
          "type": "string",
          "required": true,
          "description": "存储名称。 仅支持小写英文字母、数字、中划线 “-” 及其组合； 存储命名不能以 “-” 开头或结尾； 存储命名最大长度为 64 字符。",
          "example": "my-storage"
        }
      ],
      "required": [
        "SubAppId",
        "StorageRegion",
        "StorageName"
      ]
    },
    {
      "name": "CreateStorageCredentials",
      "description": "用于按指定策略，生成专业版应用的临时访问凭证，比如生成用于客户端上传的临时凭证。",
      "status": "online",
      "parameters": [
        {
          "name": "SubAppId",
          "type": "integer",
          "required": true,
          "description": "点播专业版[应用](/document/product/266/14574) ID。",
          "example": "123456789012"
        },
        {
          "name": "Policy",
          "type": "string",
          "required": true,
          "description": "按照下方语法组装好策略后，先序列化为字符串，再做 URL Encode，结果作为 Policy 字段入参。服务端会对该字段做 URL Decode，并按解析后的策略授予临时访问凭证权限，请按规范传入参数。 注意： 1.策略语法参照[访问管理策略](/document/product/598/10603)。 2.策略中不能包含 principal 元素。 3.策略的 action 元素仅支持：name/vod:PutObject;name/vod:ListParts;name/vod:PostObject;name/vod:InitiateMultipartUploa...",
          "example": "%7B%22statement%22%3A%5B%7B%22action%22%3A%5B%22name%2Fvod%3APutObject%22%2C%22name%2Fvod%3AListParts%22%2C%22name%2Fvod%3APostObject%22%2C%22name%2Fvod%3AInitiateMultipartUpload%22%2C%22name%2Fvod%3AUploadPart%22%2C%22name%2Fvod%3ACompleteMultipartUpload%22%2C%22name%2Fvod%3AAbortMultipartUpload%22%2C%22name%2Fvod%3AListMultipartUploads%22%5D%2C%22effect%22%3A%22allow%22%2C%22resource%22%3A%5B%22qcs%3Aap-chongqing%3Avod%3A%3Auid%2F1231456789%3Aprefix%2F%2F1234567890%2F2ceds3ew323w3mu%2Ffile_path%22%5D%7D%5D%2C%22version%22%3A%222.0%22%7D"
        },
        {
          "name": "DurationSeconds",
          "type": "integer",
          "required": false,
          "description": "指定临时证书的有效期，单位：秒。 默认 1800 秒，最大 129600 秒。",
          "example": "1800"
        }
      ],
      "required": [
        "SubAppId",
        "Policy"
      ]
    },
    {
      "name": "DeleteIncrementalMigrationStrategy",
      "description": "删除增量迁移策略。",
      "status": "online",
      "parameters": [
        {
          "name": "SubAppId",
          "type": "integer",
          "required": true,
          "description": "点播[专业版](/document/product/266/115396)[应用](/document/product/266/14574) ID。",
          "example": "1020304056"
        },
        {
          "name": "BucketId",
          "type": "string",
          "required": true,
          "description": "策略生效的存储桶 ID。",
          "example": "bucketid123"
        },
        {
          "name": "StrategyId",
          "type": "string",
          "required": true,
          "description": "增量迁移策略 ID。",
          "example": "im-demo123"
        }
      ],
      "required": [
        "SubAppId",
        "BucketId",
        "StrategyId"
      ]
    },
    {
      "name": "DescribeIncrementalMigrationStrategyInfos",
      "description": "查询增量迁移策略信息。",
      "status": "online",
      "parameters": [
        {
          "name": "SubAppId",
          "type": "integer",
          "required": true,
          "description": "点播[专业版](/document/product/266/115396)[应用](/document/product/266/14574) ID。",
          "example": "1020304056"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件，Filters.Values 的上限为 `20`；若 Filters 长度为 `0` 则查询时无过滤条件限制。 详细的过滤条件如下： BucketId   按照【存储桶 ID】进行过滤   类型：String   必选：否StrategyId   按照【策略 ID】进行过滤。   类型：String   必选：否",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "需要过滤的字段。",
              "example": "Status"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值。",
              "example": "[\"NORMAL\", \"DISABLE\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "SortBy",
          "type": "object",
          "required": false,
          "description": "返回结果的排序。 SortBy.Field 取值有：UpdateTime：创建时间。若不填，SortBy.Field 默认值为 `UpdateTime`，SortBy.Order 默认值为 `Desc`。",
          "example": "无",
          "children": [
            {
              "name": "Field",
              "type": "string",
              "required": true,
              "description": "排序字段。",
              "example": "CreateTime"
            },
            {
              "name": "Order",
              "type": "string",
              "required": true,
              "description": "排序方式，可选值有： Asc: 升序； Desc: 降序。",
              "example": "Asc"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页返回的起始偏移量，默认值为 `0`。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回的记录条数，默认值为 `20`，最大值为 `100`。",
          "example": "20"
        }
      ],
      "required": [
        "SubAppId"
      ]
    },
    {
      "name": "DescribeStorage",
      "description": "该接口用于查询专业版应用中的存储桶信息，同时支持分页查询。 注： - 本接口仅用于专业版应用。",
      "status": "online",
      "parameters": [
        {
          "name": "SubAppId",
          "type": "integer",
          "required": true,
          "description": "点播专业版[应用](/document/product/266/14574) ID。",
          "example": "1020304056"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件，Filters.Values 的上限为 20；若 Filters 长度为 0 则分页查询子应用 SubAppId 下的存储信息。 详细的过滤条件如下： BucketId   按照【存储桶 ID】进行过滤。   类型：String   必选：否 StorageName   按照【存储名称】进行过滤。   类型：String   必选：否",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "需要过滤的字段。",
              "example": "Status"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值。",
              "example": "[\"NORMAL\", \"DISABLE\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "SortBy",
          "type": "object",
          "required": false,
          "description": "返回结果的排序。 SortBy.Field 取值有： CreateTime：创建时间。若不填，SortBy.Field 默认值为 CreateTime，SortBy.Order 默认值为 Asc。",
          "example": "无",
          "children": [
            {
              "name": "Field",
              "type": "string",
              "required": true,
              "description": "排序字段。",
              "example": "CreateTime"
            },
            {
              "name": "Order",
              "type": "string",
              "required": true,
              "description": "排序方式，可选值有： Asc: 升序； Desc: 降序。",
              "example": "Asc"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页返回的起始偏移量，默认值为 0。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回的记录条数，默认值为 20，最大值为 1000。",
          "example": "20"
        }
      ],
      "required": [
        "SubAppId"
      ]
    },
    {
      "name": "ModifyIncrementalMigrationStrategy",
      "description": "创建增量迁移策略。",
      "status": "online",
      "parameters": [
        {
          "name": "SubAppId",
          "type": "integer",
          "required": true,
          "description": "点播[专业版](/document/product/266/115396)[应用](/document/product/266/14574) ID。",
          "example": "1020304056"
        },
        {
          "name": "BucketId",
          "type": "string",
          "required": true,
          "description": "策略生效的存储桶 ID。",
          "example": "bucketid123"
        },
        {
          "name": "StrategyId",
          "type": "string",
          "required": true,
          "description": "增量迁移策略 ID。",
          "example": "im-demo123"
        },
        {
          "name": "StrategyName",
          "type": "string",
          "required": false,
          "description": "策略名称。若不填充或填充空字符串，则不修改。",
          "example": "StrategyName"
        },
        {
          "name": "OriginType",
          "type": "string",
          "required": false,
          "description": "源站类型。取值有：HTTP：HTTP 源。若不填或填充空字符串，则不修改。",
          "example": "HTTP"
        },
        {
          "name": "HttpOriginConfig",
          "type": "object",
          "required": false,
          "description": "HTTP 回源源站配置，若不填则默认不修改。",
          "example": "无",
          "children": [
            {
              "name": "OriginInfo",
              "type": "object",
              "required": true,
              "description": "回源源站信息。",
              "example": "无",
              "children": [
                {
                  "name": "EndpointInfo",
                  "type": "object",
                  "required": true,
                  "description": "增量迁移源站地址信息。",
                  "example": "无",
                  "children": [
                    {
                      "name": "Endpoint",
                      "type": "string",
                      "required": true,
                      "description": "地址信息，支持域名或 IP 地址。",
                      "example": "example.com"
                    },
                    {
                      "name": "StandbyEndpointSet",
                      "type": "array",
                      "required": false,
                      "description": "备份地址信息。",
                      "example": "[\"standby.com\",\"standby2.com\"]",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "FileInfo",
                  "type": "object",
                  "required": false,
                  "description": "增量迁移源站文件信息。",
                  "example": "无",
                  "children": [
                    {
                      "name": "PrefixConfig",
                      "type": "object",
                      "required": false,
                      "description": "文件前缀配置。",
                      "example": "无"
                    },
                    {
                      "name": "SuffixConfig",
                      "type": "object",
                      "required": false,
                      "description": "文件后缀配置。",
                      "example": "无"
                    },
                    {
                      "name": "FixedFileConfig",
                      "type": "object",
                      "required": false,
                      "description": "固定文件配置。",
                      "example": "无"
                    }
                  ]
                }
              ]
            },
            {
              "name": "OriginParameter",
              "type": "object",
              "required": true,
              "description": "回源参数。",
              "example": "无",
              "children": [
                {
                  "name": "HttpHeaderInfo",
                  "type": "object",
                  "required": true,
                  "description": "HTTP 头部透传信息。",
                  "example": "无",
                  "children": [
                    {
                      "name": "HeaderFollowMode",
                      "type": "string",
                      "required": true,
                      "description": "Http Header 透传模式。取值有： FOLLOW_ALL：透传所有头部信息； FOLLOW_PART：透传部分头部信息； IGNORE_PART：忽略部分头部信息。参数必填。",
                      "example": "FOLLOW_ALL"
                    },
                    {
                      "name": "FollowHttpHeaderKeySet",
                      "type": "array",
                      "required": false,
                      "description": "需透传 Header Key 集合，仅当 HeaderFollowMode 取值 `FOLLOW_PART` 时需要填充。",
                      "example": "[\"Host\"]",
                      "item_type": "string"
                    },
                    {
                      "name": "NewHttpHeaderSet",
                      "type": "array",
                      "required": false,
                      "description": "新增 Header 键值对集合。",
                      "example": "无",
                      "item_type": "string"
                    }
                  ]
                },
                {
                  "name": "Protocol",
                  "type": "string",
                  "required": false,
                  "description": "回源协议。取值有： HTTP：强制 HTTP； HTTPS：强制 HTTPS； FOLLOW：跟随请求协议。若不填，默认取值 `FOLLOW`。",
                  "example": "HTTP"
                },
                {
                  "name": "QueryStringFollowMode",
                  "type": "string",
                  "required": false,
                  "description": "请求参数透传模式。取值有： FOLLOW：全部透传； IGNORE：忽略，全部不透传。 默认取值 `FOLLOW`。",
                  "example": "FOLLOW"
                },
                {
                  "name": "HttpRedirectCode",
                  "type": "integer",
                  "required": false,
                  "description": "重定向的 HTTP Code，目前仅支持 `301`，`302` 和 `307`。默认取值 `302`。",
                  "example": "302"
                },
                {
                  "name": "OriginRedirectionFollowMode",
                  "type": "string",
                  "required": false,
                  "description": "源站重定向跟随模式。取值有： FOLLOW：跟随源站重定向； IGNORE：忽略源站重定向。 默认取值 `FOLLOW` 跟随源站重定向，即源站返回 `3xx` 时，会默认跟随至对应源站拉取数据。",
                  "example": "FOLLOW"
                }
              ]
            },
            {
              "name": "Mode",
              "type": "string",
              "required": false,
              "description": "回源模式。取值有： SYNC：同步回源； ASYNC：异步回源。若不填，默认取 `SYNC` 同步回源。",
              "example": "SYNC"
            },
            {
              "name": "OriginCondition",
              "type": "object",
              "required": false,
              "description": "回源条件。",
              "example": "无",
              "children": [
                {
                  "name": "HttpStatusCode",
                  "type": "integer",
                  "required": false,
                  "description": "触发回源条件的 HTTP Code。若不填充，默认取值 `404`。",
                  "example": "404"
                },
                {
                  "name": "Prefix",
                  "type": "string",
                  "required": false,
                  "description": "触发回源条件的对象键前缀。",
                  "example": "prefix_test"
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "SubAppId",
        "BucketId",
        "StrategyId"
      ]
    }
  ]
}