All Products
Search
Document Center

Key Management Service:DescribeApplicationAccessPoint

Last Updated:Oct 16, 2025

Describes an application access point.

Operation description

For information about the access policy that a Resource Access Management (RAM) user or RAM role must have to call this operation, see Resource Access Management.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

Name

string

Yes

The name of the application access point (AAP) to query.

aap_test

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.

bcfefe15-46f0-44a3-bd96-3d422474b71a

Arn

string

The Alibaba Cloud Resource Name (ARN) of the AAP.

acs:kms:cn-hangzhou:119285303511****:applicationaccesspoint/aap_test

Name

string

The name of the AAP.

aap_test

Description

string

The description.

aap description

AuthenticationMethod

string

The authentication method.

ClientKey

Policies

string

The attached access policies.

["kst-hzz62ee817bvyyr5x****.efkd","kst-hzz62ee817bvyyr5x****.eyyp"]

Examples

Success response

JSON format

{
  "RequestId": "bcfefe15-46f0-44a3-bd96-3d422474b71a",
  "Arn": "acs:kms:cn-hangzhou:119285303511****:applicationaccesspoint/aap_test",
  "Name": "aap_test",
  "Description": "aap description",
  "AuthenticationMethod": "ClientKey",
  "Policies": "[\"kst-hzz62ee817bvyyr5x****.efkd\",\"kst-hzz62ee817bvyyr5x****.eyyp\"]"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter The specified parameter is not valid. An invalid value is specified for the parameter.
404 InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.