1. 接口描述
接口请求域名: scf.tencentcloudapi.com 。
获取别名的详细信息,包括名称、描述、版本、路由信息等。
默认接口请求频率限制:20次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:scf.ap-shanghai-fsi.tencentcloudapi.com。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetAlias。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
FunctionName | 是 | String | 函数名称 |
Name | 是 | String | 别名的名称 |
Namespace | 否 | String | 函数所在的命名空间 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FunctionVersion | String | 别名指向的主版本 |
Name | String | 别名的名称 |
RoutingConfig | RoutingConfig | 别名的路由信息 |
Description | String | 别名的描述 注意:此字段可能返回 null,表示取不到有效值。 |
AddTime | Timestamp | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 |
ModTime | Timestamp | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询别名详细信息
输入示例
https://scf.tencentcloudapi.com/?Action=GetAlias
&Namespace=<Namespace>
&FunctionName=<FunctionName>
&Name=<AliasName>
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "d1b93f9c-ac3a-412a-a4f3-6f0697099f72",
"FunctionVersion": "1",
"Name": "al3",
"RoutingConfig": {
"AdditionalVersionWeights": [
{
"Version": "3",
"Weight": 0.3
},
{
"Version": "2",
"Weight": 0.2
}
]
},
"Description": ""
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.GetAlias | 获取别名信息失败。 |
InternalError.System | 内部系统错误。 |
InvalidParameter.RoutingConfig | RoutingConfig参数传入错误。 |
InvalidParameterValue.FunctionName | 函数不存在。 |
InvalidParameterValue.Name | Name参数传入错误。 |
InvalidParameterValue.Namespace | Namespace参数传入错误。 |
ResourceNotFound.Alias | 别名不存在。 |
ResourceNotFound.Function | 函数不存在。 |
ResourceNotFound.FunctionName | 函数不存在。 |
ResourceNotFound.Namespace | Namespace不存在。 |
UnauthorizedOperation.CAM | CAM鉴权失败。 |