文档首页/IAM 身份中心/API参考/API/应用程序管理/查询应用程序实例详情 - GetApplicationInstance
更新时间：2025-12-12 GMT+08:00
查看PDF
分享

查询应用程序实例详情 - GetApplicationInstance

功能介绍

查询应用程序实例详情。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

IdentityCenter:application:getApplicationInstance

Read

-

-

-

organizations:delegatedAdministrators:list

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/instances/{instance_id}/application-instances/{application_instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

IAM Identity Center实例的全局唯一标识符（ID）

application_instance_id

是

String

应用程序实例ID，以app-ins-为前缀

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

application_instance

ApplicationInstanceDto object

应用程序实例

表4 ApplicationInstanceDto

参数

参数类型

描述

active_certificate

CertificateDto object

已激活的证书

display

DisplayDto object

应用程序显示信息

identity_provider_config

IdentityProviderConfigDto object

身份提供商配置信息

application_instance_id

String

应用程序实例唯一标识ID

name

String

应用程序UUID

visible

Boolean

应用程序在门户是否可见

response_config

ResponseConfigDto object

应用程序属性配置信息

response_schema_config

ResponseSchemaConfigDto object

应用程序Schema属性映射配置信息

security_config

SecurityConfigDto object

证书配置信息

status

String

应用程序实例状态

template

ApplicationTemplateDto object

应用程序所依赖模板信息

service_provider_config

ServiceProviderConfigDto object

服务提供商配置信息

client_id

String

OIDC Client ID

end_user_visible

Boolean

用户是否可见

managed_account

String

组员所属账号ID

表5 CertificateDto

参数

参数类型

描述

algorithm

String

证书生成算法

certificate

String

应用程序证书

certificate_id

String

应用程序证书Id

expiry_date

Long

证书过期时间

status

String

证书状态

key_size

String

密钥大小

issue_date

Long

证书生成时间

表6 IdentityProviderConfigDto

参数

参数类型

描述

issuer_url

String

身份提供商issuer

metadata_url

String

身份提供商元数据

remote_login_url

String

身份提供商远程登录链接

remote_logout_url

String

身份提供商远程登出链接

表7 ApplicationTemplateDto

参数

参数类型

描述

application

ApplicationTemplateDisplayDto object

应用程序模板显示信息

response_config

ResponseConfigDto object

应用程序属性配置信息

response_schema_config

ResponseSchemaConfigDto object

应用程序属性映射配置信息

sso_protocol

String

支持的协议

security_config

SecurityConfigDto object

证书配置信息

service_provider_config

ServiceProviderConfigDto object

服务提供商配置信息

template_id

String

应用程序模板唯一标识ID

template_version

String

应用程序模板版本

表8 ApplicationTemplateDisplayDto

参数

参数类型

描述

application_id

String

应用程序Id,以app-为前缀

display

DisplayDto object

应用程序显示信息

application_type

String

应用程序类型

表9 DisplayDto

参数

参数类型

描述

description

String

应用程序描述

display_name

String

应用程序显示名称

icon

String

应用程序图标

表10 ResponseConfigDto

参数

参数类型

描述

properties

Map<String,ResponseSourceDetailsDto>

额外添加的属性映射配置

subject

ResponseSourceDetailsDto object

Subject属性映射配置

relay_state

String

中继状态

ttl

String

会话过期时间

表11 ResponseSourceDetailsDto

参数

参数类型

描述

source

Array of strings

属性映射值

表12 ResponseSchemaConfigDto

参数

参数类型

描述

properties

Map<String,ResponseSchemaPropertiesDetailsDto>

额外添加的属性映射Schema配置

subject

ResponseSchemaSubjectDetailsDto object

Subject属性映射Schema配置

supported_name_id_formats

Array of strings

应用程序支持的Subject NameID格式

表13 ResponseSchemaPropertiesDetailsDto

参数

参数类型

描述

attr_name_format

String

额外添加的属性的格式

include

String

是否包含额外属性

表14 ResponseSchemaSubjectDetailsDto

参数

参数类型

描述

name_id_format

String

NameID的格式

include

String

是否包含NameID

表15 SecurityConfigDto

参数

参数类型

描述

ttl

String

证书过期时间

表16 ServiceProviderConfigDto

参数

参数类型

描述

audience

String

SAML受众

require_request_signature

Boolean

是否需要签名

consumers

Array of ConsumersDto objects

SAML响应接收方

start_url

String

应用程序启动Url

表17 ConsumersDto

参数

参数类型

描述

binding

String

SAML传输协议

default_value

Boolean

是否是默认接收方

location

String

SAML ACS Url

状态码：400

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

request_id

String

请求唯一标识

状态码：403

表19 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

request_id

String

请求唯一标识

encoded_authorization_message

String

加密的错误信息

状态码：404

表20 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

request_id

String

请求唯一标识

请求示例

查询应用程序实例详情

GET https://{hostname}/v1/instances/{instance_id}/application-instances/{application_instance_id}

响应示例

状态码：200

Successful

{
  "application_instance" : {
    "active_certificate" : {
      "algorithm" : "SHA256withRSA",
      "certificate" : "certificate text",
      "certificate_id" : "cer-ea56cf20-4ec3-445a-883f-eb70f35fe7d1",
      "expiry_date" : 1911427200000,
      "status" : "ACTIVE",
      "key_size" : "3072",
      "issue_date" : 1753695145064
    },
    "display" : {
      "description" : "teststsfs",
      "display_name" : "Custom SAML 2.0 application",
      "icon" : ""
    },
    "identity_provider_config" : {
      "issuer_url" : "https://idcenter.ulanqab.huawei.com/v1/saml/assertion/OGMxZWVmM2EyNDE5NDVmNjljM2QzYTZiMDI1MmU3ODNfZC05NDE0MDdiNGIzX2FwcC1pbnMtYTAzM2M5MDcwMTZhNTlhZQ==",
      "metadata_url" : "https://idcenter.ulanqab.huawei.com/v1/saml/metadata/OGMxZWVmM2EyNDE5NDVmNjljM2QzYTZiMDI1MmU3ODNfZC05NDE0MDdiNGIzX2FwcC1pbnMtYTAzM2M5MDcwMTZhNTlhZQ==",
      "remote_login_url" : "https://idcenter.ulanqab.huawei.com/v1/saml/assertion/OGMxZWVmM2EyNDE5NDVmNjljM2QzYTZiMDI1MmU3ODNfZC05NDE0MDdiNGIzX2FwcC1pbnMtYTAzM2M5MDcwMTZhNTlhZQ==",
      "remote_logout_url" : "https://idcenter.ulanqab.huawei.com/v1/saml/logout/OGMxZWVmM2EyNDE5NDVmNjljM2QzYTZiMDI1MmU3ODNfZC05NDE0MDdiNGIzX2FwcC1pbnMtYTAzM2M5MDcwMTZhNTlhZQ=="
    },
    "application_instance_id" : "app-ins-a033c907016a59ae",
    "name" : "a689ebed-1b68-44b0-af97-0be880c30127",
    "visible" : true,
    "response_config" : {
      "properties" : { },
      "subject" : null,
      "relay_state" : null,
      "ttl" : "PT1H"
    },
    "response_schema_config" : {
      "properties" : { },
      "subject" : null,
      "supported_name_id_formats" : null
    },
    "security_config" : {
      "ttl" : "P5Y"
    },
    "status" : "ENABLED",
    "template" : {
      "application" : {
        "application_id" : "app-ff1258a63a4a263f",
        "display" : {
          "description" : "Custom SAML 2.0 application",
          "display_name" : "Custom SAML 2.0 application",
          "icon" : ""
        },
        "application_type" : ""
      },
      "response_config" : {
        "properties" : { },
        "subject" : null,
        "relay_state" : null,
        "ttl" : "PT1H"
      },
      "response_schema_config" : {
        "properties" : { },
        "subject" : null,
        "supported_name_id_formats" : null
      },
      "sso_protocol" : "SAML",
      "security_config" : {
        "ttl" : null
      },
      "service_provider_config" : {
        "audience" : null,
        "require_request_signature" : false,
        "consumers" : null,
        "start_url" : null
      },
      "template_id" : "tpl-88f215b39bfc7575",
      "template_version" : "1"
    },
    "service_provider_config" : {
      "audience" : "https://console.ulanqab.huawei.com/identitycenter/?region=cn-north-7&locale=zh-cn#/application/add/app-ins-a033c907016a59ae",
      "require_request_signature" : false,
      "consumers" : [ {
        "binding" : "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST",
        "default_value" : true,
        "location" : "https://console.ulanqab.huawei.com/identitycenter/?region=cn-north-7&locale=zh-cn#/application/add/app-ins-a033c907016a59ae"
      } ],
      "start_url" : null
    },
    "client_id" : null,
    "end_user_visible" : null,
    "managed_account" : "8c1eef3a241945f69c3d3a6b0252e783"
  }
}

状态码

状态码

描述

200

Successful

400

Bad request

403

Forbidden

404

Not found

错误码

请参见错误码。

父主题：应用程序管理

相关文档