全部产品
阿里云办公

获取App详情

更新时间:2018-11-18 12:15:13

GetAppDetail

查询一个 App 资源某个版本的信息,包括参数信息和具体命令行等实现信息,仅支持私有 App 查询。

请求语法

请求行:

  1. GET /apps/{AppName}?Detail=True&Qualifier={Qualifier} HTTP/1.1

请求方法 GET,请求资源为 apps,请求参数为:

参数名称 类型 必选 描述
AppName string App 名称
Detail string 获取版本信息的标识,一定要设置为 “True”
Qualifier string App 资源的别名或版本号。如果没有指定该参数,那么代表查询最新版本的信息。

请求数据:

返回信息

成功

响应行:

  1. HTTP/1.1 200 OK

响应数据:

  1. {
  2. "Name": "test-copy",
  3. "Description": "Copy input file to output file",
  4. "CommandLine": "cp -rf ${inputFile} ${outputFile}",
  5. "Daemonize": false,
  6. "EnvVars": {
  7. "env-k3": "env-v3",
  8. "env-k5": "env-v5"
  9. },
  10. "InputParameters": {
  11. "inputFile": {
  12. "Default": "",
  13. "Type": "String",
  14. "Description": "Input param",
  15. "LocalPath": "/tmp/infile/"
  16. }
  17. },
  18. "OutputParameters": {
  19. "outputFile": {
  20. "Default": null,
  21. "Type": "String",
  22. "Description": "Output param",
  23. "LocalPath": "/tmp/outfile/"
  24. }
  25. },
  26. "VM": {
  27. "ECSImageId": "img-centos"
  28. },
  29. "Docker": {
  30. "Image": "ubuntu:14.04",
  31. "RegistryOSSPath": "oss://bucket/registry"
  32. },
  33. "Config": {
  34. "InstanceCount": {
  35. "Default": 1,
  36. "Description": "Instance count",
  37. "Overwritable": true
  38. },
  39. "ResourceType": {
  40. "Default": "OnDemand",
  41. "Description": "Resource type",
  42. "Overwritable": true
  43. },
  44. "DiskType": {
  45. "Default": "cloud_efficiency",
  46. "Description": "Disk type",
  47. "Overwritable": true
  48. },
  49. "MaxRetryCount": {
  50. "Default": 1,
  51. "Description": "Max retry count",
  52. "Overwritable": true
  53. },
  54. "Timeout": {
  55. "Default": 1000,
  56. "Description": "Time out",
  57. "Overwritable": true
  58. },
  59. "MinDiskSize": {
  60. "Default": 40,
  61. "Description": "Min Disk size",
  62. "Overwritable": true
  63. },
  64. "InstanceType": {
  65. "Default": "ecs.sn2ne.large",
  66. "Description": "Instance type",
  67. "Overwritable": true
  68. }
  69. }
  70. }

返回参数

参数名称 类型 描述
Name string 应用名称
Description string 应用的详细描述
InputParameters map<string, object(InputParameter)> 该应用的输入参数列表
OutputParameters map<string, object(OutputParameter)> 该应用的输出参数列表
Docker object(Docker) Docker镜像有关配置。参数 Docker 和 VM 只返回其中一个
VM object(VM) ECS虚拟机相关配置
CommandLine string 执行应用时的命令行
EnvVars map<string, string> 环境变量
Daemonize boolean 应用在执行时,是否每次都要重新启动
Config object(Config) 提交作业时的运行时参数

InputParameter

参数名称 类型 描述
Description string 参数描述
Type string 参数类型
Default string 参数默认值
LocalPath string LocalPath不为空说明该参数是OSS上的一个文件或者目录。在计算分析时,系统会将该参数值指定的OSS文件或者目录映射为本地LocalPath指定的文件或者目录。仅支持使用UTF-8编码。如果是目录,则必须以/结尾

OutputParameter

参数名称 类型 描述
Description string 参数描述
Type string 参数类型
LocalPath string LocalPath不为空说明该参数是OSS上的一个文件或者目录。在计算分析时,系统会将本地LocalPath指定的文件或者目录映射为该参数值指定的OSS文件或者目录。仅支持使用UTF-8编码。如果是目录,则必须以/结尾

Docker

参数名称 类型 描述
Image string Docker镜像
RegistryOSSPath string docker registry storage在OSS上的根目录

VM

参数名称 类型 描述
ECSImageId string ECS镜像Id

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提交作业时,是否可以覆盖掉默认值

错误