1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
查询增量迁移策略信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeIncrementalMigrationStrategyInfos。 |
Version | 是 | String | 公共参数,本接口取值:2024-07-18。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
SubAppId | 是 | Integer | 点播专业版应用 ID。 示例值:1020304056 |
Filters.N | 否 | Array of Filter | 过滤条件,Filters.Values 的上限为 20 ;若 Filters 长度为 0 则查询时无过滤条件限制。 详细的过滤条件如下: 按照【存储桶 ID】进行过滤 类型:String 必选:否 按照【策略 ID】进行过滤。 类型:String 必选:否 |
SortBy | 否 | SortBy | 返回结果的排序。 SortBy.Field 取值有:UpdateTime ,SortBy.Order 默认值为 Desc 。 |
Offset | 否 | Integer | 分页返回的起始偏移量,默认值为 0 。示例值:0 |
Limit | 否 | Integer | 分页返回的记录条数,默认值为 20 ,最大值为 100 。示例值:20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总数。 示例值:100 |
StrategyInfoSet | Array of IncrementalMigrationStrategyInfo | 策略信息集合。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询应用下的策略信息
查询当前应用下的增量迁移策略,输出按照更新时间升序排序。
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIncrementalMigrationStrategyInfos
<公共请求参数>
{
"SubAppId": 1020304056,
"SortBy": {
"Field": "UpdateTime",
"Order": "Asc"
},
"Offset": 0,
"Limit": 10
}
输出示例
{
"Response": {
"RequestId": "b6376a73-reqid-demo-b097-de6bb60b3976",
"StrategyInfoSet": [
{
"BucketId": "bucketid1",
"HttpOriginConfig": {
"Mode": "ASYNC",
"OriginCondition": {
"HttpStatusCode": 404,
"Prefix": "prefix/"
},
"OriginInfo": {
"EndpointInfo": {
"Endpoint": "example.com",
"StandbyEndpointSet": [
"standby.com",
"standby2.com"
]
},
"FileInfo": {
"PrefixConfig": {
"Prefix": "prefix"
},
"SuffixConfig": {
"Suffix": "suffix"
}
}
},
"OriginParameter": {
"HttpHeaderInfo": {
"FollowHttpHeaderKeySet": [
"Host"
],
"HeaderFollowMode": "FOLLOW_ALL",
"NewHttpHeaderSet": [
{
"Key": "Host",
"Value": "demo.com"
}
]
},
"HttpRedirectCode": 302,
"OriginRedirectionFollowMode": "FOLLOW",
"Protocol": "HTTP",
"QueryStringFollowMode": "FOLLOW"
}
},
"OriginType": "HTTP",
"StrategyId": "im-123-demoid",
"StrategyName": "my-strategy-1",
"SubAppId": 123456789
},
{
"BucketId": "bucketid2",
"HttpOriginConfig": {
"Mode": "SYNC",
"OriginCondition": {
"HttpStatusCode": 404
},
"OriginInfo": {
"EndpointInfo": {
"Endpoint": "example.com"
}
},
"OriginParameter": {
"HttpHeaderInfo": {
"HeaderFollowMode": "IGNORE_ALL",
"NewHttpHeaderSet": [
{
"Key": "host",
"Value": "demo.com"
}
]
},
"HttpRedirectCode": 301,
"OriginRedirectionFollowMode": "FOLLOW",
"Protocol": "HTTPS",
"QueryStringFollowMode": "FOLLOW"
}
},
"OriginType": "HTTP",
"StrategyId": "im-123-demoid2",
"StrategyName": "my-strategy-2",
"SubAppId": 123456789
}
],
"TotalCount": 2
}
}
示例2 查询应用指定存储桶的增量迁移策略
查询应用指定存储桶的增量迁移策略
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIncrementalMigrationStrategyInfos
<公共请求参数>
{
"SubAppId": 1020304056,
"Filters": [
{
"Name": "BucketId",
"Values": [
"bucketid2"
]
}
],
"SortBy": {
"Field": "UpdateTime",
"Order": "Asc"
},
"Offset": 0,
"Limit": 10
}
输出示例
{
"Response": {
"RequestId": "a70a4fb9-reqid-demo-aa39-3282aa745a26",
"StrategyInfoSet": [
{
"BucketId": "bucketid2",
"HttpOriginConfig": {
"Mode": "SYNC",
"OriginCondition": {
"HttpStatusCode": 404
},
"OriginInfo": {
"EndpointInfo": {
"Endpoint": "example2.com"
}
},
"OriginParameter": {
"HttpHeaderInfo": {
"HeaderFollowMode": "IGNORE_ALL",
"NewHttpHeaderSet": [
{
"Key": "host",
"Value": "demo.com"
}
]
},
"HttpRedirectCode": 301,
"OriginRedirectionFollowMode": "FOLLOW",
"Protocol": "HTTPS",
"QueryStringFollowMode": "FOLLOW"
}
},
"OriginType": "HTTP",
"StrategyId": "im-123-demoid2",
"StrategyName": "my-strategy-2",
"SubAppId": 123456789
}
],
"TotalCount": 1
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |