Updated on 2024-05-30 GMT+08:00

Obtaining App Details

Function

This API is used to obtain details about a specified app.

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}/app-auth/apps/{app_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

app_id

Yes

String

App ID.

project_id

Yes

String

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

workspace_id

No

String

Workspace ID.

iphertext_enabled

No

Boolean

Whether to display in plaintext.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

Message body type. text/plain indicates that a temporary preview URL is returned. application/octet-stream indicates that a temporary download URL is returned.

X-Auth-Token

Yes

String

User token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

app

ApigAppDetailInfo object

Basic information about the created app

Table 5 ApigAppDetailInfo

Parameter

Type

Description

app_codes

Array of strings

App code list. When app_type is APIC, this parameter is left blank.

app_id

String

App ID

app_key

String

App key

app_name

String

App name

app_remark

String

App description, which is left blank by default. The value contains a maximum of 200 characters.

app_secret

String

App secret key

app_type

String

App type. Enums:

  • APIC: This App is registered with the ROMA Connect gateway.

  • APIG: This App is registered with the shared API gateway.

  • DEDICATE_APIG: This App is registered with the dedicated API gateway.

bounded_api_count

Integer

Number of APIs bound to the app

created_at

Long

Time when an app is created

project_id

String

Project ID

updated_at

Long

App update time

user_id

String

ID of the user who creates the app

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts.

error_msg

String

Error message.

Status code: 404

Table 8 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}/app-auth/apps/{app_id}

Example Responses

Status code: 200

OK

{
  "app" : {
    "app_id" : "logic-app-7ded3898-8306-49ee-a1df-2708f9aac83a",
    "app_name" : "app_c8ae",
    "app_key" : "9cdbfd0b65364fbe8b1c6cf29255a46f",
    "app_secret" : "c736b99bdc33403ab0652bf91c00e99e",
    "user_id" : "04f258c8fb00d42a1f65c00df88cc4dc",
    "project_id" : "04f258c84780d5a52f3bc00dc15aa5e7",
    "app_type" : "DEDICATE_APIG",
    "app_codes" : [ ],
    "created_at" : 1703162733450,
    "updated_at" : 1703162733450,
    "bounded_api_count" : 0
  }
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.