Get Policy Details - GetIAMPolicy
Overview
Get Policy Details
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetIAMPolicy . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
PolicyURN | string | Strategy URN | Yes |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Policy | IAMPolicy | Policy Information | Yes |
Data Model
IAMPolicy
Field Name | Type | Description Information | Required |
---|---|---|---|
PolicyName | string | Policy Name | No |
PolicyURN | string | IAM Policy URN | No |
Description | string | IAM Policy Description | No |
Document | string | IAM Policy Text | No |
ScopeType | string | IAM Permission Policy Application Scope (ScopeRequired: Project Level, ScopeEmpty: Global Level, ScopeUnrestricted: Project Level/Global Level) | No |
CreatedAt | int | IAM Policy Creation Time | No |
UpdatedAt | int | IAM Policy Update Time | No |
Example
Request Example
https://api.surfercloud.com/?Action=GetIAMPolicy
&PolicyURN=iAVnENEZ
Response Example
{
"Action": "GetIAMPolicyResponse",
"Message": "MJEfQQTC",
"Policy": {},
"RetCode": 0
}