matreche/modelarts-umn
1
0
Fork 0
forked from docs/modelarts
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reimport api with latest import script (#23)

Browse Source 
Reimport api with latest import script

fix various links

Reviewed-by: Beibei <None>
Reviewed-by: kucerakk <kucerakk@gmail.com>
This commit is contained in:
Artem Goncharov 2022-04-20 10:30:45 +02:00 committed by GitHub
parent c34050e171
commit 10a5d8856a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
187 changed files with 11796 additions and 13722 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

254
api-ref/source/api_overview.rst
View File

File diff suppressed because it is too large Load Diff

64
api-ref/source/application_cases/creating_a_training_job_using_the_tensorflow_framework.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/application_cases/index.rst
View File

@ -1,3 +1,5 @@
.. _modelarts_03_0400:
=================
Application Cases
=================

26
api-ref/source/authorization_management/configuring_authorization.rst
View File

@ -1,3 +1,5 @@
.. _CreateAuthorization:
Configuring Authorization
=========================
@ -13,25 +15,21 @@ POST /v2/{project_id}/authorizations
.. table:: **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 <../common_parameters/obtaining_a_project_id_and_name.html>`__. |
+------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+==================================================================================================================+
| project_id | Yes | String | Project ID. For details about how to obtain a project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
.. _CreateAuthorizationrequestAuthorizationRequest:
.. table:: **Table 2** Request body parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+====================================================================================================================================================+
| user_id | No | String | User ID. For details about how to obtain a user ID, see `Obtaining a User ID <../common_parameters/obtaining_a_username_and_id.html>`__. |
| user_id | No | String | User ID. For details about how to obtain a user ID, see :ref:`Obtaining a User ID <modelarts_03_0006>`. |
| | | | |
| | | | If **user_id** is set to **all**, all IAM users are authorized. If some IAM users have been authorized, the authorization setting will be updated. |
| | | | |
@ -92,10 +90,6 @@ OK
Status Codes
------------
.. _CreateAuthorizationstatuscode:
=========== ============
Status Code Description
=========== ============
@ -109,6 +103,4 @@ Status Code Description
Error Codes
-----------
See `Error Codes <../common_parameters/error_codes.html>`__.
See :ref:`Error Codes <modelarts_03_0095>`.

24
api-ref/source/authorization_management/creating_a_modelarts_agency.rst
View File

@ -1,3 +1,5 @@
.. _CreateModelArtsAgency:
Creating a ModelArts Agency
===========================
@ -13,19 +15,15 @@ POST /v2/{project_id}/agency
.. table:: **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 <../common_parameters/obtaining_a_project_id_and_name.html>`__. |
+------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+==================================================================================================================+
| project_id | Yes | String | Project ID. For details about how to obtain a project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
.. _CreateModelArtsAgencyrequestCreateModelArtsAgencyRequest:
.. table:: **Table 2** Request body parameters
+--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+
@ -76,10 +74,6 @@ OK
Status Codes
------------
.. _CreateModelArtsAgencystatuscode:
=========== ============
Status Code Description
=========== ============
@ -93,6 +87,4 @@ Status Code Description
Error Codes
-----------
See `Error Codes <../common_parameters/error_codes.html>`__.
See :ref:`Error Codes <modelarts_03_0095>`.

20
api-ref/source/authorization_management/deleting_authorization.rst
View File

@ -1,3 +1,5 @@
.. _DeleteAuthorizations:
Deleting Authorization
======================
@ -13,11 +15,11 @@ DELETE /v2/{project_id}/authorizations
.. table:: **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 <../common_parameters/obtaining_a_project_id_and_name.html>`__. |
+------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+==================================================================================================================+
| project_id | Yes | String | Project ID. For details about how to obtain a project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 2** Query parameters
@ -62,10 +64,6 @@ OK
Status Codes
------------
.. _DeleteAuthorizationsstatuscode:
=========== ============
Status Code Description
=========== ============
@ -79,6 +77,4 @@ Status Code Description
Error Codes
-----------
See `Error Codes <../common_parameters/error_codes.html>`__.
See :ref:`Error Codes <modelarts_03_0095>`.

2
api-ref/source/authorization_management/index.rst
View File

@ -1,3 +1,5 @@
.. _authorization:
========================
Authorization Management
========================

44
api-ref/source/authorization_management/viewing_an_authorization_list.rst
View File

@ -1,3 +1,5 @@
.. _GetAuthorizations:
Viewing an Authorization List
=============================
@ -13,11 +15,11 @@ GET /v2/{project_id}/authorizations
.. table:: **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 <../common_parameters/obtaining_a_project_id_and_name.html>`__. |
+------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+==================================================================================================================+
| project_id | Yes | String | Project ID. For details about how to obtain a project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 2** Query parameters
@ -61,30 +63,24 @@ Response Parameters
**Status code: 200**
.. _GetAuthorizationsresponseAuthorizationListResponse:
.. table:: **Table 3** Response body parameters
+-------------+----------------------------------------------------------------------------------------------+---------------------------------+
| Parameter | Type | Description |
+=============+==============================================================================================+=================================+
| total_count | Number | Authorization information. |
+-------------+----------------------------------------------------------------------------------------------+---------------------------------+
| auth | Array of `AuthorizationResponse <#getauthorizationsresponseauthorizationresponse>`__ objects | Authorization information list. |
+-------------+----------------------------------------------------------------------------------------------+---------------------------------+
+-------------+---------------------------------------------------------------------------------------------------+---------------------------------+
| Parameter | Type | Description |
+=============+===================================================================================================+=================================+
| total_count | Number | Authorization information. |
+-------------+---------------------------------------------------------------------------------------------------+---------------------------------+
| auth | Array of :ref:`AuthorizationResponse <getauthorizations__response_authorizationresponse>` objects | Authorization information list. |
+-------------+---------------------------------------------------------------------------------------------------+---------------------------------+
.. _GetAuthorizationsresponseAuthorizationResponse:
.. _getauthorizations__response_authorizationresponse:
.. table:: **Table 4** AuthorizationResponse
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+====================================================================================================================================================+
| user_id | String | User ID. For details about how to obtain a user ID, see `Obtaining a User ID <../common_parameters/obtaining_a_username_and_id.html>`__. |
| user_id | String | User ID. For details about how to obtain a user ID, see :ref:`Obtaining a User ID <modelarts_03_0006>`. |
| | | |
| | | If **user_id** is set to **all**, all IAM users are authorized. If some IAM users have been authorized, the authorization setting will be updated. |
| | | |
@ -143,10 +139,6 @@ OK
Status Codes
------------
.. _GetAuthorizationsstatuscode:
=========== ============
Status Code Description
=========== ============
@ -160,6 +152,4 @@ Status Code Description
Error Codes
-----------
See `Error Codes <../common_parameters/error_codes.html>`__.
See :ref:`Error Codes <modelarts_03_0095>`.

6
api-ref/source/before_you_start/api_calling.rst
View File

@ -1,6 +1,6 @@
.. _modelarts_03_0140:
API Calling
===========
ModelArts supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see `Calling APIs <../calling_apis/making_an_api_request.html#modelarts030005>`__.
ModelArts supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see :ref:`Calling APIs <modelarts_03_0005>`.

6
api-ref/source/before_you_start/basic_concepts.rst
View File

@ -1,3 +1,5 @@
.. _modelarts_03_0143:
Basic Concepts
==============
@ -17,10 +19,10 @@ Basic Concepts
Projects group and isolate compute, storage, and network resources across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
.. _modelarts_03_0143__en-us_topic_0171316292_en-us_topic_0170640577_en-us_topic_0169294976_fig1189614168311:
.. figure:: /_static/images/en-us_image_0171392261.gif
:alt: **Figure 1** Project isolation model
**Figure 1** Project isolation model

10
api-ref/source/before_you_start/endpoints.rst
View File

@ -1,13 +1,13 @@
.. _modelarts_03_0141:
Endpoints
=========
Endpoints are **request address** for calling APIs. Endpoints vary depending on services and regions. To obtain the regions and endpoints, contact the enterprise administrator.
A service endpoint consists of the service name, region ID, and external domain name in the format of "{service_name}.{region_id}.{external_domain_name}". For details about how to obtain each parameter, see `Table 1 <#modelarts030141enustopic0000001072357044table8700253831>`__.
A service endpoint consists of the service name, region ID, and external domain name in the format of "{service_name}.{region_id}.{external_domain_name}". For details about how to obtain each parameter, see :ref:`Table 1 <modelarts_03_0141__en-us_topic_0000001072357044_table8700253831>`.
.. _modelarts030141enustopic0000001072357044table8700253831:
.. _modelarts_03_0141__en-us_topic_0000001072357044_table8700253831:
.. table:: **Table 1** Obtaining an endpoint
@ -24,5 +24,3 @@ A service endpoint consists of the service name, region ID, and external domain
.. important::
If an endpoint uses a domain name, configure the hosts file in the format of "{float-ip} {service_name}.{region_id}.{external_domain_name}" on the local PC. Obtain **float-ip** from the administrator.

2
api-ref/source/before_you_start/index.rst
View File

@ -1,3 +1,5 @@
.. _modelarts_03_0139:
================
Before You Start
================

6
api-ref/source/before_you_start/overview.rst
View File

@ -1,6 +1,6 @@
.. _modelarts_03_0001:
Overview
========
ModelArts is a one-stop AI development platform geared toward developers and data scientists of all skill levels. It enables you to rapidly build, train, and deploy models anywhere (from the cloud to the edge), and manage full-lifecycle AI workflows. ModelArts accelerates AI development and fosters AI innovation with key capabilities, including data preprocessing and auto labeling, distributed training, automated model building, and one-click workflow execution. You can use ModelArts through open APIs. For details about all ModelArts APIs, see `API Overview <../api_overview.html>`__.
ModelArts is a one-stop AI development platform geared toward developers and data scientists of all skill levels. It enables you to rapidly build, train, and deploy models anywhere (from the cloud to the edge), and manage full-lifecycle AI workflows. ModelArts accelerates AI development and fosters AI innovation with key capabilities, including data preprocessing and auto labeling, distributed training, automated model building, and one-click workflow execution. You can use ModelArts through open APIs. For details about all ModelArts APIs, see :ref:`API Overview <modelarts_03_0002>`.

18
api-ref/source/calling_apis/authentication.rst
View File

@ -1,3 +1,5 @@
.. _modelarts_03_0004:
Authentication
==============
@ -15,7 +17,7 @@ Token-based Authentication
A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.
In `Making an API Request <../calling_apis/making_an_api_request.html#modelarts030005>`__, the process of calling the API used to obtain a user token is described.
In :ref:`Making an API Request <modelarts_03_0005>`, the process of calling the API used to obtain a user token is described.
.. code-block::
@ -90,7 +92,11 @@ Decompress the downloaded package and reference the obtained JAR files as depend
#. Download and decompress the demo project.
#. Import the demo project to Eclipse.
#. .. _modelarts_03_0004__en-us_topic_0129435566_li94791126103617:
Import the demo project to Eclipse.
.. _modelarts_03_0004__en-us_topic_0129435566_fig10881944183710:
.. figure:: /_static/images/en-us_image_0150917346.gif
:alt: **Figure 1** Selecting Existing Projects into Workspace
@ -98,12 +104,16 @@ Decompress the downloaded package and reference the obtained JAR files as depend
**Figure 1** Selecting Existing Projects into Workspace
.. _modelarts_03_0004__en-us_topic_0129435566_fig15961458113717:
.. figure:: /_static/images/en-us_image_0150917350.gif
:alt: **Figure 2** Selecting the demo project
**Figure 2** Selecting the demo project
.. _modelarts_03_0004__en-us_topic_0129435566_fig74501929113815:
.. figure:: /_static/images/en-us_image_0150917353.gif
:alt: **Figure 3** Structure of the demo project
@ -112,7 +122,7 @@ Decompress the downloaded package and reference the obtained JAR files as depend
#. Sign the request.
The request signing method is integrated in the JAR files imported in `3 <#modelarts030004enustopic0129435566li94791126103617>`__. The request needs to be signed before it is sent. The signature will then be added as part of the HTTP header to the request.
The request signing method is integrated in the JAR files imported in :ref:`3 <modelarts_03_0004__en-us_topic_0129435566_li94791126103617>`. The request needs to be signed before it is sent. The signature will then be added as part of the HTTP header to the request.
The demo code is classified into the following classes to demonstrate signing and sending the HTTP request:
@ -183,7 +193,5 @@ Decompress the downloaded package and reference the obtained JAR files as depend
You can view the API call logs on the console.
.. |image1| image:: /_static/images/en-us_image_0150916848.gif

2
api-ref/source/calling_apis/index.rst
View File

@ -1,3 +1,5 @@
.. _modelarts_03_0144:
============
Calling APIs
============

26
api-ref/source/calling_apis/making_an_api_request.rst
View File

@ -1,8 +1,12 @@
.. _modelarts_03_0005:
Making an API Request
=====================
This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs.
.. _modelarts_03_0005__en-us_topic_0129435569_en-us_topic_0170917207_en-us_topic_0168405763_section1849899574:
Request URI
-----------
@ -10,10 +14,6 @@ The format of a request URI is as follows:
**{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}**
.. _modelarts030005enustopic0129435569enustopic0170917207enustopic0168405763table442645372610:
.. table:: **Table 1** Request URI
+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -21,7 +21,7 @@ The format of a request URI is as follows:
+===============+=====================================================================================================================================================================================================================================================================+
| URI-scheme | Protocol used to transmit requests. All APIs use HTTPS. |
+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Endpoint | Domain name or IP address of the server for the REST service endpoint. The endpoint varies depending on services in different regions. It can be obtained in `Endpoints <../before_you_start/endpoints.html>`__. |
| Endpoint | Domain name or IP address of the server for the REST service endpoint. The endpoint varies depending on services in different regions. It can be obtained in :ref:`Endpoints <modelarts_03_0141>`. |
+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource-path | Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the **resource-path** of the API used to obtain a user token is **/v3/auth/tokens**. |
+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -43,14 +43,10 @@ Request Methods
The HTTP protocol defines the following request methods that can be used to send a request to the server:
.. _modelarts030005enustopic0129435569enustopic0113746487table1961229113819:
.. table:: **Table 2** HTTP methods
+-----------------------------------+----------------------------------------------------------------------------+
| **Method** | **Description** |
| Method | Description |
+===================================+============================================================================+
| GET | Requests the server to return specified resources. |
+-----------------------------------+----------------------------------------------------------------------------+
@ -78,11 +74,9 @@ Request Header
You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add **Content-Type**, which specifies the request body type.
`Table 3 <#modelarts030005enustopic0129435569table139019272562>`__ describes the common request header fields to be added to the request.
:ref:`Table 3 <modelarts_03_0005__en-us_topic_0129435569_table139019272562>` describes the common request header fields to be added to the request.
.. _modelarts030005enustopic0129435569table139019272562:
.. _modelarts_03_0005__en-us_topic_0129435569_table139019272562:
.. table:: **Table 3** Common request header fields
@ -134,7 +128,7 @@ The body of a request is often sent in a structured format as specified in the C
The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
If an API is used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace *user_name*, *domain_name*, and *user_password* with the actual username, account name, and login password, respectively. **project_name** is the project name. For details, see `Obtaining a Username <../common_parameters/obtaining_a_username_and_id.html#modelarts030006>`__, `Obtaining an Account Name and ID <../common_parameters/obtaining_an_account_name_and_id.html#modelarts030148>`__, and `Obtaining a Project Name <../common_parameters/obtaining_a_project_id_and_name.html#modelarts030147>`__.
If an API is used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace *user_name*, *domain_name*, and *user_password* with the actual username, account name, and login password, respectively. **project_name** is the project name. For details, see :ref:`Obtaining a Username <modelarts_03_0006>`, :ref:`Obtaining an Account Name and ID <modelarts_03_0148>`, and :ref:`Obtaining a Project Name <modelarts_03_0147>`.
.. note::
@ -167,5 +161,3 @@ If an API is used to obtain a user token, the request parameters and parameter d
}
If all data required for the API request is available, you can send the request to call the API through `curl <https://curl.haxx.se/>`__, `Postman <https://www.getpostman.com/>`__, or coding. In the response to the API used to obtain a user token, **x-subject-token** is the desired user token. This token can then be used to authenticate the calling of other APIs.

16
api-ref/source/calling_apis/response.rst
View File

@ -1,3 +1,5 @@
.. _modelarts_03_0003:
Response
========
@ -6,7 +8,7 @@ After sending a request, you will receive a response, including the status code,
Status Code
-----------
A status code is a group of digits, ranging from 1\ *xx* to 5\ *xx*. It indicates the status of a request. For more information, see `Status Code <../common_parameters/status_code.html#modelarts030094>`__.
A status code is a group of digits, ranging from 1\ *xx* to 5\ *xx*. It indicates the status of a request. For more information, see :ref:`Status Code <modelarts_03_0094>`.
For example, if status code **201** is returned for calling the API used to obtain a user token, the request is successful.
@ -15,10 +17,6 @@ Response Header
Similar to a request, a response also has a header, for example, **Content-type**.
.. _modelarts030003enustopic0171310283table14216843:
.. table:: **Table 1** Common response header fields
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+
@ -55,10 +53,12 @@ Similar to a request, a response also has a header, for example, **Content-type*
| | Default value: hour | |
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+
Figure 1 shows the response header fields for the API used to obtain a user token.
:ref:`Figure 1 <modelarts_03_0003__en-us_topic_0171310283_en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511>` shows the response header fields for the API used to obtain a user token.
**x-subject-token** is the desired user token. This token can then be used to authenticate the calling of other APIs.
.. _modelarts_03_0003__en-us_topic_0171310283_en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511:
.. figure:: /_static/images/en-us_image_0171113090.png
:alt: **Figure 1** Header fields of the response to the request for obtaining a user token
@ -96,6 +96,4 @@ If an error occurs during API calling, an error code and a message will be displ
"error_code": "AS.0001"
}
In the error response body, **error_code** is an error code, and **error_message** provides information about the error. For more details, see `Error Codes <../common_parameters/error_codes.html>`__.
In the error response body, **error_code** is an error code, and **error_message** provides information about the error. For more details, see :ref:`Error Codes <modelarts_03_0095>`.

6
api-ref/source/change_history.rst
View File

@ -1,10 +1,8 @@
.. _modelarts_03_0097:
Change History
==============
.. _modelarts030097enustopic0135263212table1819116292310:
=========== ===================================
Released On Description
=========== ===================================

4
api-ref/source/common_parameters/error_codes.rst
View File

@ -1,3 +1,5 @@
.. _modelarts_03_0095:
Error Codes
===========
@ -1132,5 +1134,3 @@ Error Codes
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500 | ModelArts.7101 | Call pdp auth api failed. | PDP request error. | System error. Contact technical support. |
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

2
api-ref/source/common_parameters/index.rst
View File

@ -1,3 +1,5 @@
.. _modelarts_03_0093:
=================
Common Parameters
=================

14
api-ref/source/common_parameters/obtaining_a_project_id_and_name.rst
View File

@ -1,3 +1,5 @@
.. _modelarts_03_0147:
Obtaining a Project ID and Name
===============================
@ -6,8 +8,10 @@ Scenarios
A project ID or name is required for some requests when an API is called. Therefore, obtain the project ID and name before calling the API. Use either of the following methods:
- `Obtaining a Project ID and Name from the Console <#obtaining-a-project-id-and-name-from-the-console>`__
- `Obtaining a Project ID by Calling an API <#obtaining-a-project-id-by-calling-an-api>`__
- :ref:`Obtaining a Project ID and Name from the Console <modelarts_03_0147__en-us_topic_0171436477_section1747620762418>`
- :ref:`Obtaining a Project ID by Calling an API <modelarts_03_0147__en-us_topic_0171436477_section3926171216207>`
.. _modelarts_03_0147__en-us_topic_0171436477_section1747620762418:
Obtaining a Project ID and Name from the Console
------------------------------------------------
@ -18,10 +22,12 @@ To do so, perform the following operations:
#. In the upper right corner, click your account avatar icon and choose **My Settings** from the drop-down list.
#. On the **My Settings** page, go to the **Project List** tab page, which is displayed by default. View the project ID and name in the project list.
.. _modelarts_03_0147__en-us_topic_0171436477_section3926171216207:
Obtaining a Project ID by Calling an API
----------------------------------------
The API for obtaining a project ID is **GET https://**\ *{iam-endpoint}*\ **/v3/projects**. To obtain *{iam-endpoint}*, see `Request URI <../calling_apis/making_an_api_request.html#request-uri>`__\ `Endpoints <../before_you_start/endpoints.html>`__.
The API for obtaining a project ID is **GET https://**\ *{iam-endpoint}*\ **/v3/projects**. To obtain *{iam-endpoint}*, see :ref:`Request URI <modelarts_03_0005__en-us_topic_0129435569_en-us_topic_0170917207_en-us_topic_0168405763_section1849899574>`\ :ref:`Endpoints <modelarts_03_0141>`.
The following is an example response. For example, if ModelArts is deployed in the **xxx** region, the value of **name** in the response body is **xxx**. The value of **id** in **projects** is the project ID.
@ -48,5 +54,3 @@ The following is an example response. For example, if ModelArts is deployed in t
"self": "https://www.example.com/v3/projects"
}
}

6
api-ref/source/common_parameters/obtaining_a_username_and_id.rst
View File

@ -1,3 +1,5 @@
.. _modelarts_03_0006:
Obtaining a Username and ID
===========================
@ -9,10 +11,10 @@ When you call APIs, certain requests require the username and ID. To obtain a us
On the **My Settings** page, view the username and ID.
.. _modelarts_03_0006__en-us_topic_0000001124853294_fig173616433916:
.. figure:: /_static/images/en-us_image_0000001126895190.png
:alt: **Figure 1** Viewing the username and ID
**Figure 1** Viewing the username and ID

6
api-ref/source/common_parameters/obtaining_an_account_name_and_id.rst
View File

@ -1,3 +1,5 @@
.. _modelarts_03_0148:
Obtaining an Account Name and ID
================================
@ -9,10 +11,10 @@ When you call APIs, certain requests require the account name and ID. To obtain
On the **API Credentials** page, view the account name and ID.
.. _modelarts_03_0148__en-us_topic_0171436478_fig816634061619:
.. figure:: /_static/images/en-us_image_0000001126894914.png
:alt: **Figure 1** Viewing the account name and ID
**Figure 1** Viewing the account name and ID

10
api-ref/source/common_parameters/status_code.rst
View File

@ -1,11 +1,11 @@
.. _modelarts_03_0094:
Status Code
===========
`Table 1 <#modelarts030094enustopic0132773864table1450010510213>`__ describes the status codes.
:ref:`Table 1 <modelarts_03_0094__en-us_topic_0132773864_table1450010510213>` describes the status codes.
.. _modelarts030094enustopic0132773864table1450010510213:
.. _modelarts_03_0094__en-us_topic_0132773864_table1450010510213:
.. table:: **Table 1** Status codes
@ -120,5 +120,3 @@ Status Code
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 505 | HTTP Version not supported | The server does not support the HTTP protocol version used in the request. |
+-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

876
api-ref/source/data_management/data_export_task/creating_a_dataset_export_task.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/data_management/data_export_task/index.rst
View File

@ -1,3 +1,5 @@
.. _data_export:
================
Data Export Task
================

502
api-ref/source/data_management/data_export_task/querying_the_dataset_export_task_list.rst
View File

File diff suppressed because it is too large Load Diff

392
api-ref/source/data_management/data_export_task/querying_the_status_of_a_dataset_export_task.rst
View File

File diff suppressed because it is too large Load Diff

372
api-ref/source/data_management/data_import_task/creating_an_import_task.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/data_management/data_import_task/index.rst
View File

@ -1,3 +1,5 @@
.. _data_import:
================
Data Import Task
================

252
api-ref/source/data_management/data_import_task/querying_details_about_a_dataset_import_task.rst
View File

File diff suppressed because it is too large Load Diff

266
api-ref/source/data_management/data_import_task/querying_the_dataset_import_task_list.rst
View File

File diff suppressed because it is too large Load Diff

342
api-ref/source/data_management/data_management_apis.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/data_management/data_synchronization_task/index.rst
View File

@ -1,3 +1,5 @@
.. _data_sync:
=========================
Data Synchronization Task
=========================

28
api-ref/source/data_management/data_synchronization_task/querying_the_status_of_a_dataset_synchronization_task.rst
View File

@ -1,3 +1,5 @@
.. _SyncDataSourceState:
Querying the Status of a Dataset Synchronization Task
=====================================================
@ -13,13 +15,13 @@ GET /v2/{project_id}/datasets/{dataset_id}/sync-data/status
.. table:: **Table 1** Path parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+============================================================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see `Obtaining a Project ID <../../common_parameters/obtaining_a_project_id_and_name.html>`__. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+====================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -31,10 +33,6 @@ Response Parameters
**Status code: 200**
.. _SyncDataSourceStateresponseSyncDataSourceStatusResp:
.. table:: **Table 2** Response body parameters
+-----------------------+-----------------------+-----------------------------------------------+
@ -99,10 +97,6 @@ OK
Status Codes
------------
.. _SyncDataSourceStatestatuscode:
=========== ============
Status Code Description
=========== ============
@ -115,6 +109,4 @@ Status Code Description
Error Codes
-----------
See `Error Codes <../../common_parameters/error_codes.html>`__.
See :ref:`Error Codes <modelarts_03_0095>`.

24
api-ref/source/data_management/data_synchronization_task/synchronizing_a_dataset.rst
View File

@ -1,3 +1,5 @@
.. _SyncDataSource:
Synchronizing a Dataset
=======================
@ -13,13 +15,13 @@ POST /v2/{project_id}/datasets/{dataset_id}/sync-data
.. table:: **Table 1** Path parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+============================================================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see `Obtaining a Project ID <../../common_parameters/obtaining_a_project_id_and_name.html>`__. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+====================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -48,10 +50,6 @@ None
Status Codes
------------
.. _SyncDataSourcestatuscode:
=========== ============
Status Code Description
=========== ============
@ -64,6 +62,4 @@ Status Code Description
Error Codes
-----------
See `Error Codes <../../common_parameters/error_codes.html>`__.
See :ref:`Error Codes <modelarts_03_0095>`.

498
api-ref/source/data_management/dataset_management/creating_a_dataset.rst
View File

File diff suppressed because it is too large Load Diff

24
api-ref/source/data_management/dataset_management/deleting_a_dataset.rst
View File

@ -1,3 +1,5 @@
.. _DeleteDataset:
Deleting a Dataset
==================
@ -13,13 +15,13 @@ DELETE /v2/{project_id}/datasets/{dataset_id}
.. table:: **Table 1** Path parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+============================================================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see `Obtaining a Project ID <../../common_parameters/obtaining_a_project_id_and_name.html>`__. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+====================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -54,10 +56,6 @@ No Content
Status Codes
------------
.. _DeleteDatasetstatuscode:
=========== ============
Status Code Description
=========== ============
@ -69,6 +67,4 @@ Status Code Description
Error Codes
-----------
See `Error Codes <../../common_parameters/error_codes.html>`__.
See :ref:`Error Codes <modelarts_03_0095>`.

2
api-ref/source/data_management/dataset_management/index.rst
View File

@ -1,3 +1,5 @@
.. _dataset_management:
==================
Dataset Management
==================

174
api-ref/source/data_management/dataset_management/modifying_a_dataset.rst
View File

File diff suppressed because it is too large Load Diff

216
api-ref/source/data_management/dataset_management/querying_dataset_statistics.rst
View File

File diff suppressed because it is too large Load Diff

1082
api-ref/source/data_management/dataset_management/querying_details_about_a_dataset.rst
View File

File diff suppressed because it is too large Load Diff

220
api-ref/source/data_management/dataset_management/querying_details_about_team_labeling_task_statistics.rst
View File

File diff suppressed because it is too large Load Diff

32
api-ref/source/data_management/dataset_management/querying_details_about_the_progress_of_a_team_labeling_task_member.rst
View File

@ -1,3 +1,5 @@
.. _GetWorkforceTaskMetrics:
Querying Details About the Progress of a Team Labeling Task Member
==================================================================
@ -13,15 +15,15 @@ GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/m
.. table:: **Table 1** Path parameters
+-------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===================+===========+========+============================================================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+-------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see `Obtaining a Project ID <../../common_parameters/obtaining_a_project_id_and_name.html>`__. |
+-------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| workforce_task_id | Yes | String | ID of a team labeling task. |
+-------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===================+===========+========+====================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| workforce_task_id | Yes | String | ID of a team labeling task. |
+-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -33,10 +35,6 @@ Response Parameters
**Status code: 200**
.. _GetWorkforceTaskMetricsresponseGetWorkforceTaskMetricResp:
.. table:: **Table 2** Response body parameters
+--------------+---------------------------------+-------------------------------------------+
@ -79,10 +77,6 @@ OK
Status Codes
------------
.. _GetWorkforceTaskMetricsstatuscode:
=========== ============
Status Code Description
=========== ============
@ -95,6 +89,4 @@ Status Code Description
Error Codes
-----------
See `Error Codes <../../common_parameters/error_codes.html>`__.
See :ref:`Error Codes <modelarts_03_0095>`.

28
api-ref/source/data_management/dataset_management/querying_the_monitoring_data_of_a_dataset.rst
View File

@ -1,3 +1,5 @@
.. _GetDatasetMetrics:
Querying the Monitoring Data of a Dataset
=========================================
@ -13,13 +15,13 @@ GET /v2/{project_id}/datasets/{dataset_id}/metrics
.. table:: **Table 1** Path parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+============================================================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see `Obtaining a Project ID <../../common_parameters/obtaining_a_project_id_and_name.html>`__. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+====================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 2** Query parameters
@ -43,10 +45,6 @@ Response Parameters
**Status code: 200**
.. _GetDatasetMetricsresponseGetDatasetMetricResp:
.. table:: **Table 3** Response body parameters
+-----------+---------------------------------+---------------------------------+
@ -99,10 +97,6 @@ OK
Status Codes
------------
.. _GetDatasetMetricsstatuscode:
=========== ============
Status Code Description
=========== ============
@ -115,6 +109,4 @@ Status Code Description
Error Codes
-----------
See `Error Codes <../../common_parameters/error_codes.html>`__.
See :ref:`Error Codes <modelarts_03_0095>`.

1112
api-ref/source/data_management/dataset_management/response_body_for_querying_the_dataset_list..rst
View File

File diff suppressed because it is too large Load Diff

32
api-ref/source/data_management/dataset_version_management/creating_a_dataset_labeling_version.rst
View File

@ -1,3 +1,5 @@
.. _CreateDatasetVersion:
Creating a Dataset Labeling Version
===================================
@ -13,21 +15,17 @@ POST /v2/{project_id}/datasets/{dataset_id}/versions
.. table:: **Table 1** Path parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+============================================================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see `Obtaining a Project ID <../../common_parameters/obtaining_a_project_id_and_name.html>`__. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+====================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
.. _CreateDatasetVersionrequestCreateDatasetVersionReq:
.. table:: **Table 2** Request body parameters
+-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -77,10 +75,6 @@ Response Parameters
**Status code: 201**
.. _CreateDatasetVersionresponseCreateDatasetVersionResp:
.. table:: **Table 3** Response body parameters
========== ====== ===================
@ -119,10 +113,6 @@ Created
Status Codes
------------
.. _CreateDatasetVersionstatuscode:
=========== ============
Status Code Description
=========== ============
@ -135,6 +125,4 @@ Status Code Description
Error Codes
-----------
See `Error Codes <../../common_parameters/error_codes.html>`__.
See :ref:`Error Codes <modelarts_03_0095>`.

28
api-ref/source/data_management/dataset_version_management/deleting_a_dataset_labeling_version.rst
View File

@ -1,3 +1,5 @@
.. _DeleteDatasetVersion:
Deleting a Dataset Labeling Version
===================================
@ -13,15 +15,15 @@ DELETE /v2/{project_id}/datasets/{dataset_id}/versions/{version_id}
.. table:: **Table 1** Path parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+============================================================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see `Obtaining a Project ID <../../common_parameters/obtaining_a_project_id_and_name.html>`__. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| version_id | Yes | String | Dataset version ID. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+====================================================================================================================+
| dataset_id | Yes | String | Dataset ID. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
| version_id | Yes | String | Dataset version ID. |
+------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -56,10 +58,6 @@ No Content
Status Codes
------------
.. _DeleteDatasetVersionstatuscode:
=========== ============
Status Code Description
=========== ============
@ -71,6 +69,4 @@ Status Code Description
Error Codes
-----------
See `Error Codes <../../common_parameters/error_codes.html>`__.
See :ref:`Error Codes <modelarts_03_0095>`.

2
api-ref/source/data_management/dataset_version_management/index.rst
View File

@ -1,3 +1,5 @@
.. _dataset_version_management:
==========================
Dataset Version Management
==========================

542
api-ref/source/data_management/dataset_version_management/querying_details_about_a_dataset_version.rst
View File

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More