Creating a ModelArts Agency

Function

This API is used to create an agency so that ModelArts can access dependent services such as OBS, SWR, and IEF.

Debugging

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

URI

POST /v2/{project_id}/agency

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

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

agency_name_suffix

No

String

Agency name suffix.

The parameter contains a maximum of 50 characters.

The agency name prefix is consistently to be ma_agency.

For example, if the value of this parameter is iam-user01, the name of the created agency is ma_agency_iam-user01.

The value of this parameter is left blank by default, indicating that an agency named modelarts_agency is created.

Response Parameters

None

Example Requests

Create a ModelArts agency.

POST https://{endpoint}/v2/{project_id}/agency

{
  "agency_name_suffix" : "iam-user01"
}

Example Responses

Status code: 200

OK

{
  "agency_name" : "ma_agency_iam-user01"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.