Help Center/ ModelArts/ API Reference/ Resource Management/ Querying OS Configuration Parameters
Updated on 2024-05-30 GMT+08:00
View PDF
Share

Querying OS Configuration Parameters

Function

Obtain the configuration parameters of the ModelArts OS service, such as the network segment and user resource quota.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v1/{project_id}/os-user-config

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID and Name.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

networkCidrs

Array of strings

Network configuration item.

networkQuota

Integer

Specifies the number of networks that a user can create.

poolQuota

Integer

Specifies the quota for the number of resource pools that can be created by a user.

pooHighAvailable

Boolean

Specifies whether HA resource pools can be created in the current environment or site.

Status code: 404

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v1/{project_id}/os-user-config

Example Responses

Status code: 200

OK.

{
  "networkCidrs" : [ "192.168.0.0/24", "172.16.31.0/16" ],
  "networkQuota" : 15,
  "poolQuota" : 15,
  "pooHighAvailable" : true
}

Status Codes

Status Code

Description

200

OK.

404

Not Found.

Error Codes

See Error Codes.

Parent topic: Resource Management