DescribeAttestors - Query attestors | Security Center API - Security Center

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeAttestors

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	222.35.XXX.XXX
Name	string	No	The attestor name.	attestor-auto-ad5316
CurrentPage	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7BC55C8F-226E-5AF5-9A2C-2EC43864****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries.	122
Count	integer	The number of entries on the current page.	20
Attestors	array<object>	The attestors.
	object	The attestor details.
KeyVersionId	string	The version ID of the Key Management Service (KMS) key.	8d7c9c91-57ce-4cf4-a959-1e700e13****
KeyId	string	The ID of the KMS key.	2e81355b-f8e7-4090-8082-a8f8124a****
Remark	string	The attestor description.	attestor
Name	string	The attestor name.	attestor-123
KeyRegionId	string	The region ID of the KMS key.	cn-hangzhou

Examples

Success response

JSON format

{
  "RequestId": "7BC55C8F-226E-5AF5-9A2C-2EC43864****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 122,
    "Count": 20
  },
  "Attestors": [
    {
      "KeyVersionId": "8d7c9c91-57ce-4cf4-a959-1e700e13****",
      "KeyId": "2e81355b-f8e7-4090-8082-a8f8124a****",
      "Remark": "attestor",
      "Name": "attestor-123",
      "KeyRegionId": "cn-hangzhou"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.