CheckCertificate-阿里云帮助中心

Checks the expiration time and current status of the iOS certificate for a specified app.

Operation description

If the returned ExpireTime value is later than the current timestamp, the certificate is not necessarily valid. Also verify that the Status is OK.
The REVOKED status originates from the Apple Push Notification service (APNs) server. If a certificate has a REVOKED status, at least one push notification to APNs has failed in the corresponding environment.

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

mpush:CheckCertificate

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppKey	integer	Yes	The AppKey of the application.	23267207

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC
Android	boolean	Indicates whether the AppKey belongs to an Android app: true false Valid values: true : true false : false	false
IOS	boolean	Indicates whether the AppKey belongs to an iOS app: true false Valid values: true : true false : false	true
ProductionCertInfo	object	The information about the certificate for the production environment.
Status	string	The status of the certificate. Valid values: EXPIRED: The certificate is expired. NOT_CONFIGURED: The certificate is not configured. NO_PASSWORD: The password for the certificate is not configured. OK: The certificate is normal. REVOKED: The certificate is revoked. Valid values: REVOKED : REVOKED NO_PASSWORD : NO_PASSWORD EXPIRED : EXPIRED NOT_CONFIGURED : NOT_CONFIGURED OK : OK	OK
ExipreTime	integer	The expiration time of the certificate.	1764561600000
DevelopmentCertInfo	object	The information about the certificate for the development or sandbox environment.
Status	string	The status of the certificate. Valid values: EXPIRED: The certificate is expired. NOT_CONFIGURED: The certificate is not configured. NO_PASSWORD: The password for the certificate is not configured. OK: The certificate is normal. REVOKED: The certificate is revoked. Valid values: REVOKED : REVOKED NO_PASSWORD : NO_PASSWORD EXPIRED : EXPIRED NOT_CONFIGURED : NOT_CONFIGURED OK : OK	EXPIRED
ExipreTime	integer	The expiration time of the certificate.	1470024000000

Examples

Success response

JSON format

{
  "RequestId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC",
  "Android": false,
  "IOS": true,
  "ProductionCertInfo": {
    "Status": "OK",
    "ExipreTime": 1764561600000
  },
  "DevelopmentCertInfo": {
    "Status": "EXPIRED",
    "ExipreTime": 1470024000000
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid%s.NotFound	The specified %s is not found.
400	AccountDisabled	Your account is not enabled.
400	PermissionDenied	The specified AppKey is not authorized.
500	InternalError	The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.