查询OS的配置参数 - ShowOsConfig
功能介绍
查询OS配置参数接口用于获取ModelArts OS服务的配置信息。该接口适用于以下场景:在系统部署时确认网络网段配置、资源分配前检查用户配额限制、或故障排查时验证服务参数配置。使用该接口的前提条件是用户需具备管理员权限且ModelArts OS服务处于运行状态。调用后将返回指定配置参数的详细信息,用户可根据返回数据进行网络规划或资源分配决策。若用户权限不足、服务不可用或请求参数不存在,接口将返回对应错误码及提示信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/os-user-config
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1-64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| networkCidrs | Array of strings | 参数解释:网络配置项。 |
| networkQuota | Integer | 参数解释:用户可创建网络个数配额。 取值范围:不涉及 |
| networkSubnetTypes | Array of strings | 参数解释:可选的网络子网类型列表。 |
| poolQuota | Integer | 参数解释:用户可创建资源池个数配额。 取值范围:不涉及 |
| poolHighAvailable | Boolean | 参数解释:当前环境/局点是否支持创建高可用资源池。 取值范围: |
| maxPoolFlavors | Integer | 参数解释:资源池支持包含的最多的资源规格数量。 取值范围:不涉及。 |
| clusterFlavorSpecs | String | 参数解释:k8s集群管理节点规格列表。 取值范围:不涉及。 |
| licenseScopeType | String | 参数解释:当前环境导入的license支持创建的作业类型。 取值范围:可选值如下: |
| nodeOSVersionSupport | Array of OsVersion objects | 参数解释:支持选择的节点镜像版本列表。 |
| volumeTypes | Array of strings | 参数解释:支持的磁盘类型。 |
| poolScopePlugins | Array of PoolScopePlugin objects | 参数解释:资源池作业类型相关配置信息。 |
| liteClusterSupportCceVersions | Array of strings | 参数解释:创建lite cluster支持选择的cce集群版本列表。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释:系统镜像的名称。 取值范围:不涉及。 |
| endOfService | String | 参数解释:系统镜像的服务到期时间。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| scope | String | 参数解释:作业类型。 取值范围:可选值如下: |
| plugins | Array of strings | 参数解释:插件列表。 |
| externalDependency | Boolean | 参数解释:是否有外部依赖。 取值范围:可选值如下: |
| supportRetry | Boolean | 参数解释:是否支持失败重试。 取值范围:可选值如下: |
| reservedNetworkCidr | Array of strings | 参数解释:保留网段。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:ModelArts错误码。 取值范围:不涉及。 |
| error_msg | String | 参数解释:具体错误信息。 取值范围:不涉及。 |
请求示例
GET https://{endpoint}/v1/{project_id}/os-user-config 响应示例
状态码:200
{
"clusterFlavorSpecs" : [ "cce.s1.small", "cce.s1.medium", "cce.s2.small", "cce.s2.medium", "cce.s2.large", "cce.s2.xlarge" ],
"licenseScopeType" : "multi",
"liteClusterSupportCceVersions" : [ "v1.28", "v1.31", "v1.33" ],
"maxPoolFlavors" : 10,
"networkCidrs" : [ "192.168.0.0/24", "172.16.31.0/16" ],
"networkQuota" : 15,
"networkSubnetTypes" : [ "", "clouddcn" ],
"nodeOSVersionSupport" : [ {
"name" : "EulerOS 2.1",
"endOfService" : "2019-12-31"
}, {
"name" : "EulerOS 2.2",
"endOfService" : "2021-12-31"
}, {
"name" : "EulerOS 2.3",
"endOfService" : "2022-12-31"
}, {
"name" : "EulerOS 2.5",
"endOfService" : "2024-12-31"
}, {
"name" : "EulerOS 2.8",
"endOfService" : "2024-12-31"
}, {
"name" : "EulerOS 2.9",
"endOfService" : "2025-12-31"
}, {
"name" : "EulerOS 2.10",
"endOfService" : "2026-12-31"
} ],
"poolHighAvailable" : false,
"poolQuota" : 15,
"poolScopePlugins" : [ {
"scope" : "Train",
"plugins" : [ "volcano" ]
}, {
"scope" : "Infer",
"plugins" : [ "volcano" ],
"reservedNetworkCidr" : [ "192.168.0.0/16", "172.16.0.0/16", "10.247.0.0/16" ],
"externalDependency" : true,
"supportRetry" : true
}, {
"scope" : "Notebook",
"externalDependency" : true,
"supportRetry" : true
} ],
"volumeTypes" : [ "SSD", "GPSSD", "SAS" ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK。 |
| 404 | Not Found。 |
错误码
请参见错误码。