modelarts-umn/api-ref/source/authorization_management/creating_a_modelarts_agency.rst
otcbot[bot] 4317c860a8
Update content (#31)
Changes to ma_api from doc-exports#1


This is an automatically created Pull Request for changes to ma_api in opentelekomcloud-docs/doc-exports#1.
Please do not edit it manually, since update to the original PR will overwrite local changes.
Original patch file, as well as complete rst archive,  can be found in the artifacts of the opentelekomcloud-docs/doc-exports#1

Reviewed-by: Vineet Pruthi <None>
2022-05-02 14:51:57 +00:00

4.2 KiB

original_name

CreateModelArtsAgency.html

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.

URI

POST /v2/{project_id}/agency

Table 1 Path parameters
Parameter Mandatory Type Description
project_id Yes String Project ID. For details about how to obtain a project ID, see Obtaining a Project ID <modelarts_03_0147>.

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 <modelarts_03_0095>.