描述
查询一个app资源,支持公共App和私有App。
请求
GET /apps/{AppName}?Scope={Scope}
参数说明
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
AppName | string | 是 | App名称 |
Scope | string | 否 | 可以为Public或Private。如果为Public,那么代表查询公共App;如果为Private或者不指定,那么代表查询私有App |
返回信息
返回状态码
HTTP/1.1 200 OK
返回消息体
{
"Name": string,
"Description": string,
"CreationTime": string,
"InputParameters": {
string: {
"Description": string,
"Type": string,
"Default": string
},
...
},
"OutputParameters": {
string: {
"Description": string,
"Type": string
},
...
},
"Config": {
"ResourceType": {
"Description": string,
"Default": string,
"Overwritable": boolean
},
"InstanceType": {
"Description": string,
"Default": string,
"Overwritable": boolean
},
"InstanceCount": {
"Description": string,
"Default": number,
"Overwritable": boolean
},
"MinDiskSize": {
"Description": string,
"Default": number,
"Overwritable": boolean
},
"DiskType": {
"Description": string,
"Default": string,
"Overwritable": boolean
},
"MaxRetryCount": {
"Description": string,
"Default": number,
"Overwritable": boolean
},
"Timeout": {
"Description": string,
"Default": number,
"Overwritable": boolean
}
}
}
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
Name | string | 应用名称 |
Description | string | 应用的详细描述 |
CreationTime | string | 资源创建时间 |
InputParameters | map<string, object(InputParameter)> | 该应用的输入参数列表 |
OutputParameters | map<string, object(OutputParameter)> | 该应用的输出参数列表 |
Config | object(Config) | 提交作业时的运行时参数 |
InputParameter
参数名称 | 类型 | 描述 |
---|---|---|
Description | string | 参数描述 |
Type | string | 参数类型 |
Default | string | 参数默认值 |
OutputParameter
参数名称 | 类型 | 描述 |
---|---|---|
Description | string | 参数描述 |
Type | string | 参数类型 |
Config
参数名称 | 类型 | 描述 |
---|---|---|
ResourceType | object(ResourceType) | 资源类型 |
InstanceType | object(InstanceType) | 实例类型 |
InstanceCount | object(InstanceCount) | 实例数量 |
MinDiskSize | object(MinDiskSize) | 最小磁盘大小(GB) |
DiskType | object(DiskType) | 磁盘类型 |
MaxRetryCount | object(MaxRetryCount) | 某个Instance失败后,最大重试次数 |
Timeout | object(Timeout) | Instance的运行时超时时间,单位为秒 |
ResourceType
参数名称 | 类型 | 描述 |
---|---|---|
Description | string | 给APP使用者的详细描述 |
Default | string | 参数默认值 |
Overwritable | boolean | 用户使用该APP提交作业时,是否可以覆盖掉默认值 |
InstanceType
参数名称 | 类型 | 描述 |
---|---|---|
Description | string | 给APP使用者的详细描述 |
Default | string | 参数默认值 |
Overwritable | boolean | 用户使用该APP提交作业时,是否可以覆盖掉默认值 |
InstanceCount
参数名称 | 类型 | 描述 |
---|---|---|
Description | string | 给APP使用者的详细描述 |
Default | number | 参数默认值 |
Overwritable | boolean | 用户使用该APP提交作业时,是否可以覆盖掉默认值 |
MinDiskSize
参数名称 | 类型 | 描述 |
---|---|---|
Description | string | 给APP使用者的详细描述 |
Default | number | 参数默认值 |
Overwritable | boolean | 用户使用该APP提交作业时,是否可以覆盖掉默认值 |
DiskType
参数名称 | 类型 | 描述 |
---|---|---|
Description | string | 给APP使用者的详细描述 |
Default | string | 参数默认值 |
Overwritable | boolean | 用户使用该APP提交作业时,是否可以覆盖掉默认值 |
MaxRetryCount
参数名称 | 类型 | 描述 |
---|---|---|
Description | string | 给APP使用者的详细描述 |
Default | number | 参数默认值 |
Overwritable | boolean | 用户使用该APP提交作业时,是否可以覆盖掉默认值 |
Timeout
参数名称 | 类型 | 描述 |
---|---|---|
Description | string | 给APP使用者的详细描述 |
Default | number | 参数默认值 |
Overwritable | boolean | 用户使用该APP提交作业时,是否可以覆盖掉默认值 |
示例
请求:
GET /apps/myapp?Scope=Public HTTP/1.1
响应:
HTTP/1.1 200 OK
{
"Config": {
"DiskType": {
"Default": "cloud_efficiency",
"Description": "",
"Overwritable": true},
"InstanceCount": {
"Default": 1,
"Description": "",
"Overwritable": true},
"InstanceType": {
"Default": "",
"Description": "",
"Overwritable": true},
"MaxRetryCount": {
"Default": 0,
"Description": "",
"Overwritable": true},
"MinDiskSize": {
"Default": 40,
"Description": "",
"Overwritable": true},
"ResourceType": {
"Default": "OnDemand",
"Description": "",
"Overwritable": true},
"Timeout": {
"Default": 86400,
"Description": "",
"Overwritable": true}},
"CreationTime": "2017-08-14T07:10:41.281465Z",
"Description": "app description",
"InputParameters": {
"inputFile": {
"Default": null,
"Description": "",
"Type": "String"}},
"Name": "myapp",
"OutputParameters": {
"outputFile": {
"Description": "",
"Type": "String"}},
"OwnerId": 123456}