获取可用参数模板列表 - ListUPgSQLParamTemplate
简介
获取可用参数模板列表
定义
公共参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Action | string | 对应的 API 指令名称，当前 API 为 ListUPgSQLParamTemplate | Yes |
| PublicKey | string | 用户公钥，可从 控制台 获取 | Yes |
| Signature | string | 根据公钥及 API 指令生成的用户签名，参见 签名算法 | Yes |
请求参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Region | string | 地域。 参见 地域和可用区列表 | Yes |
| Zone | string | 可用区。参见 可用区列表 | Yes |
| ProjectId | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口 | No |
| Offset | int | 偏移量, 默认是0,100 | No |
| Count | int | 总数 | No |
响应字段
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| RetCode | int | 返回状态码，为 0 则为成功返回，非 0 为失败 | Yes |
| Action | string | 操作指令名称 | Yes |
| Message | string | 返回错误消息，当 RetCode 非 0 时提供详细的描述信息 | No |
| Data | array[TemplateGroup] | 参数模板信息 | Yes |
数据模型
TemplateGroup
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| GroupID | int | 参数模板ID | No |
| GroupName | string | 参数模板名称 | No |
| DBVersion | string | 应用的DB版本 | No |
| Description | string | 描述信息 | No |
| Modifiable | boolean | 是否可以修改 | No |
| ParamGroupTypeName | string | 模板组类型名称 | No |
示例
请求示例
https://api.an-link.com/?Action=ListUPgSQLParamTemplate
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=EJimHTRB
&Offset=4
&Count=1响应示例
{
"Action": "ListUPgSQLParamTemplateResponse",
"Data": [
{
"DbVersion": "mgmMARnm",
"Description": "TGVwMNYJ",
"GroupId": 1,
"GroupName": "ytGWHtVS",
"Modifiable": true,
"ParamGroupTypeName": "znltxisP"
}
],
"Message": "YabdGJdS",
"RetCode": 0
}