GetWorkload - 获取模型信息_人工智能平台 PAI(PAI)-阿里云帮助中心

获取模型信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
eflo:GetWorkload	get	*Workload `acs:eflo:{#regionId}:{#accountId}:workload/{#WorkloadId}`	无	无

请求参数

名称	类型	必填	描述	示例值
WorkloadId	long	是	负载 id	13

返回参数

名称	类型	描述	示例值
	object	结果
Data	object	数据
WorkloadId	long	负载 id	13
WorkloadName	string	负载名称	test
WorkloadDescription	string	负载描述	test
WorkloadType	string	负载名称	AI
Family	string	负载簇, AI、GPU	AI
Scene	string	负载使用场景	NLP-LLM
Scope	string	负载使用的范围标识	common
JobKind	string	训练任务类型	PyTorchJob
DefaultCpuPerWorker	integer	默认 cpu 分配数	90
DefaultGpuPerWorker	integer	默认 gpu 分配数	8
DefaultMemoryPerWorker	integer	默认内存 GB 分配数	500
DefaultShareMemory	integer	默认共享内存 GB 分配数	500
ParamSettings	array<object>	参数设置
ParamSetting	object	参数
ParamName	string	参数名称	ITERATION
ParamDesc	string	参数描述	迭代数
ParamValue	string	参数值	100
DefaultValue	string	参数默认值	100
ParamRegex	string	参数正则表达式	[0-9]+
ParamType	string	参数类型	number
StaticConfig	object	静态配置
FrameWork	string	框架	PyTorch
SoftwareStack	string	软件栈	python
Os	string	系统	linux
Parameters	string	参数量	7B
VersionId	long	版本号	1
RequestId	string	请求 id	E67E2E4C-2B47-5C55-AA17-1D771E070AEF
AccessDeniedDetail	string	无权限信息	{}
TotalCount	long	查询总数	0

示例

正常返回示例

JSON格式

{
  "Data": {
    "WorkloadId": 13,
    "WorkloadName": "test",
    "WorkloadDescription": "test",
    "WorkloadType": "AI",
    "Family": "AI",
    "Scene": "NLP-LLM",
    "Scope": "common",
    "JobKind": "PyTorchJob",
    "DefaultCpuPerWorker": 90,
    "DefaultGpuPerWorker": 8,
    "DefaultMemoryPerWorker": 500,
    "DefaultShareMemory": 500,
    "ParamSettings": [
      {
        "ParamName": "ITERATION",
        "ParamDesc": "迭代数",
        "ParamValue": 100,
        "DefaultValue": 100,
        "ParamRegex": "[0-9]+",
        "ParamType": "number"
      }
    ],
    "StaticConfig": {
      "FrameWork": "PyTorch",
      "SoftwareStack": "python",
      "Os": "linux",
      "Parameters": "7B"
    },
    "VersionId": 1
  },
  "RequestId": "E67E2E4C-2B47-5C55-AA17-1D771E070AEF",
  "AccessDeniedDetail": {},
  "TotalCount": 0
}

错误码

HTTP status code	错误码	错误信息	描述
400	NotFound	not found.	数据不存在

访问错误中心查看更多错误码。