全部产品
Search
文档中心

获取App信息

更新时间: 2018-05-11

描述

查询一个app资源,支持公共App和私有App。

请求

  1. GET /apps/{AppName}?Scope={Scope}

参数说明

参数名称 类型 必选 描述
AppName string App名称
Scope string 可以为Public或Private。如果为Public,那么代表查询公共App;如果为Private或者不指定,那么代表查询私有App

返回信息

返回状态码

  1. HTTP/1.1 200 OK

返回消息体

  1. {
  2. "Name": string,
  3. "Description": string,
  4. "CreationTime": string,
  5. "InputParameters": {
  6. string: {
  7. "Description": string,
  8. "Type": string,
  9. "Default": string
  10. },
  11. ...
  12. },
  13. "OutputParameters": {
  14. string: {
  15. "Description": string,
  16. "Type": string
  17. },
  18. ...
  19. },
  20. "Config": {
  21. "ResourceType": {
  22. "Description": string,
  23. "Default": string,
  24. "Overwritable": boolean
  25. },
  26. "InstanceType": {
  27. "Description": string,
  28. "Default": string,
  29. "Overwritable": boolean
  30. },
  31. "InstanceCount": {
  32. "Description": string,
  33. "Default": number,
  34. "Overwritable": boolean
  35. },
  36. "MinDiskSize": {
  37. "Description": string,
  38. "Default": number,
  39. "Overwritable": boolean
  40. },
  41. "DiskType": {
  42. "Description": string,
  43. "Default": string,
  44. "Overwritable": boolean
  45. },
  46. "MaxRetryCount": {
  47. "Description": string,
  48. "Default": number,
  49. "Overwritable": boolean
  50. },
  51. "Timeout": {
  52. "Description": string,
  53. "Default": number,
  54. "Overwritable": boolean
  55. }
  56. }
  57. }

返回参数

参数名称 类型 描述
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提交作业时,是否可以覆盖掉默认值

示例

请求:

  1. GET /apps/myapp?Scope=Public HTTP/1.1

响应:

  1. HTTP/1.1 200 OK
  2. {
  3. "Config": {
  4. "DiskType": {
  5. "Default": "cloud_efficiency",
  6. "Description": "",
  7. "Overwritable": true},
  8. "InstanceCount": {
  9. "Default": 1,
  10. "Description": "",
  11. "Overwritable": true},
  12. "InstanceType": {
  13. "Default": "",
  14. "Description": "",
  15. "Overwritable": true},
  16. "MaxRetryCount": {
  17. "Default": 0,
  18. "Description": "",
  19. "Overwritable": true},
  20. "MinDiskSize": {
  21. "Default": 40,
  22. "Description": "",
  23. "Overwritable": true},
  24. "ResourceType": {
  25. "Default": "OnDemand",
  26. "Description": "",
  27. "Overwritable": true},
  28. "Timeout": {
  29. "Default": 86400,
  30. "Description": "",
  31. "Overwritable": true}},
  32. "CreationTime": "2017-08-14T07:10:41.281465Z",
  33. "Description": "app description",
  34. "InputParameters": {
  35. "inputFile": {
  36. "Default": null,
  37. "Description": "",
  38. "Type": "String"}},
  39. "Name": "myapp",
  40. "OutputParameters": {
  41. "outputFile": {
  42. "Description": "",
  43. "Type": "String"}},
  44. "OwnerId": 123456}