All Products
Search
Document Center

API Gateway:DescribeAppSecurity

Last Updated:Jul 31, 2025

This key is used for authentication when an API call is made.

Operation description

  • This operation is intended for API callers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:DescribeAppSecurityget
*App
acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdlongYes

The ID of the app.

20112314518278
Tagarray<object>No

The tag of objects that match the rule. You can specify multiple tags.

Key, Value
objectNo
KeystringYes

The key of the tag.

app
ValuestringNo

The value of the tag.

123

Response parameters

ParameterTypeDescriptionExample
object
AppSecretstring

The password of the app.

c1ae97aaa7e45f21d10824bc44678fee
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
AppKeystring

The key of the app.

60030986
ModifiedTimestring

The modification time (UTC) of the key.

2016-07-31T04:10:19Z
AppCodestring

The AppCode of the app.

3aaf905a0a1f4f0eabc6d891dfa08afc
CreatedTimestring

The creation time (UTC) of the key, which is the same as the app creation time.

2016-07-31T04:10:19Z

Examples

Sample success responses

JSONformat

{
  "AppSecret": "c1ae97aaa7e45f21d10824bc44678fee",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "AppKey": 60030986,
  "ModifiedTime": "2016-07-31T04:10:19Z",
  "AppCode": "3aaf905a0a1f4f0eabc6d891dfa08afc",
  "CreatedTime": "2016-07-31T04:10:19Z"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-11-14API Description UpdateView Change Details