Help Center/ ModelArts/ Drawer/ Deploying a Real-Time Service/ Application Authentication
Updated on 2025-05-29 GMT+08:00
Share

Application Authentication

Description

After you enable application authentication, ModelArts registers an API that supports application authentication for the service. After this API is authorized to an application, you can call this API using the AppKey/AppSecret or AppCode of the application.

  • AppKey/AppSecret-based authentication: The AppKey and AppSecret are used to encrypt a request, identify the sender, and prevent the request from being modified. When using AppKey/AppSecret-based authentication, use a dedicated signing SDK to sign requests.
    • AppKey: access key ID of the application, which is a unique identifier used together with a secret access key to sign requests cryptographically.
    • AppSecret: application secret access key, used together with the Access Key ID to encrypt the request, identify the sender, and prevent the request from being tempered.

    AppKeys can be used for simple authentication. When an API is called, the apikey parameter (value: AppKey) is added to the HTTP request header to accelerate authentication.

  • AppCode-based authentication: Requests are authenticated using AppCodes.

    In AppCode-based authentication, the X-Apig-AppCode parameter (value: AppCode) is added to the HTTP request header for an API call. The request content does not need to be signed. The API gateway only verifies the AppCode, achieving quick response.

FAQs

How Do I Access Real-Time Services Through Application Authentication?

  1. Enable application authentication during service deployment.
  2. On the Usage Guides tab of the service details page, obtain the API URL, AppKey/AppSecret, and AppCode. If a path is defined for API parameters in the model configuration file, the API URL must be followed by the user-defined path, for example, {API URL}/predictions/poetry.
  3. Send a prediction request.
    • Method 1: Use Python to send an inference request through AppKey/AppSecret-based authentication.
    • Method 2: Use Java to send an inference request through AppKey/AppSecret-based authentication.
    • Method 3: Use Python to send an inference request through AppCode-based authentication.
    • Method 4: Use Java to send an inference request through AppCode-based authentication.

APIG.0101 Incorrect Prediction URL

  • After application authentication is enabled, two API URLs are displayed in the Usage Guides tab of the service details page. To access the real-time service through application authentication, use the APIs that support application authentication.
  • If a path is specified with the apis parameter in the model configuration file, the API URL must be followed by the user-defined path, for example, {API URL}/predictions/poetry.

Learn More

Access Authenticated Using an Application: Manage created applications, including viewing, resetting, or deleting applications, binding or unbinding corresponding real-time services, and obtaining AppKey/AppSecret or AppCode.

Parent Topic: Deploying a Real-Time Service