All Products
Search
Document Center

Key Management Service:DescribeApplicationAccessPoint

更新時間:Oct 11, 2023

Queries the details of an application access point (AAP).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes DescribeApplicationAccessPoint

The operation that you want to perform. Set the value to DescribeApplicationAccessPoint.

Name String Yes aap_test

The name of the AAP that you want to query.

Response parameters

Parameter

Type

Example

Description

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

The ID of the request, which is used to locate and troubleshoot issues.

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

The ARN of the AAP.

Name String aap_test

The name of the AAP.

Description String aap description

The description.

AuthenticationMethod String ClientKey

The authentication method.

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

The permission policy that is bound to the AAP.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeApplicationAccessPoint
&Name=aap_test
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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. The specified parameter is invalid.
404 InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records. The specified AccessKey ID does not exist.

For a list of error codes, see Service error codes.