查询OS的配置参数 - ShowOsConfig
功能介绍
查询OS的配置参数接口用于获取ModelArts 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 | 参数解释：用户可创建网络个数配额。 取值范围：不涉及 |
poolQuota | Integer | 参数解释：用户可创建资源池个数配额。 取值范围：不涉及 |
poolHighAvailable | Boolean | 参数解释：当前环境/局点是否支持创建高可用资源池。 取值范围： |
状态码：404
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释：ModelArts错误码。 取值范围：不涉及。 |
error_msg | String | 参数解释：具体错误信息。 取值范围：不涉及。 |
请求示例
GET https://{endpoint}/v1/{project_id}/os-user-config 响应示例
状态码：200
OK。
{
"networkCidrs" : [ "192.168.0.0/24", "172.16.31.0/16" ],
"networkQuota" : 15,
"poolQuota" : 15,
"poolHighAvailable" : true
} 状态码
状态码 | 描述 |
|---|---|
200 | OK。 |
404 | Not Found。 |
错误码
请参见错误码。
