DescribeCertificateState - Certificate Management Service

Menanyakan status pesanan permintaan sertifikat tertentu.

Deskripsi operasi

Jika Anda belum menyelesaikan validasi kepemilikan domain setelah mengirimkan permintaan sertifikat, Anda dapat memanggil operasi ini untuk memperoleh informasi yang diperlukan guna menyelesaikan validasi tersebut. Informasi validasi domain yang dikembalikan dapat digunakan untuk menyelesaikan validasi melalui platform manajemen DNS (metode validasi DNS) atau di server domain (metode validasi file).

Pesanan permintaan sertifikat Anda hanya akan memasuki tahap peninjauan oleh pusat CA setelah validasi domain selesai. Setelah pusat CA menyetujui permintaan sertifikat Anda, sertifikat akan diterbitkan. Jika sertifikat telah diterbitkan, Anda dapat memanggil operasi ini untuk mengambil file sertifikat dan konten kunci privat yang bersangkutan.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cert:DescribeCertificateState

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	ID pesanan permintaan sertifikat yang akan ditanyakan. Catatan Anda dapat memanggil ListUserCertificateOrder untuk mendapatkan ID ini.	123451222

Saat memanggil operasi API, selain parameter permintaan spesifik operasi tersebut, Anda juga harus menyertakan parameter permintaan umum Alibaba Cloud.

Untuk format permintaan saat memanggil operasi API, lihat contoh permintaan di bagian Examples topik ini.

Elemen respons

Element	Type	Description	Example
	object	Objek.
Type	string	Status pesanan permintaan sertifikat. Nilai yang valid: domain_verify: Pending validation, yang menunjukkan bahwa Anda belum menyelesaikan validasi domain setelah mengirimkan permintaan sertifikat. Catatan Setelah mengirimkan permintaan sertifikat, Anda harus menyelesaikan validasi kepemilikan domain secara manual sebelum permintaan sertifikat dapat memasuki tahap peninjauan. Jika Anda belum menyelesaikan validasi domain, Anda dapat merujuk ke parameter respons operasi ini untuk menyelesaikan validasi domain. process: Under review, yang menunjukkan bahwa permintaan sertifikat sedang ditinjau oleh pusat CA. verify_fail: Review failed, yang menunjukkan bahwa permintaan sertifikat gagal dalam peninjauan. Catatan Peninjauan dapat gagal karena informasi permintaan sertifikat yang Anda kirimkan salah. Kami menyarankan agar Anda memanggil DeleteCertificateRequest untuk menghapus pesanan yang gagal ditinjau (pesanan yang dihapus tidak mengurangi kuota paket sumber daya sertifikat) dan mengirimkan permintaan sertifikat baru. certificate: Issued, yang menunjukkan bahwa sertifikat telah diterbitkan. payed: Pending request, yang menunjukkan bahwa sertifikat sedang menunggu permintaan. unknow: Unknown status.	domain_verify
Domain	string	Nama domain yang akan divalidasi saat Anda menggunakan metode validasi file untuk validasi domain. Anda perlu menghubungkan ke server yang sesuai dengan nama domain ini dan membuat file yang ditentukan (yaitu Uri) di server tersebut. Catatan Parameter ini hanya dikembalikan ketika Type diatur ke domain_verify (menunjukkan tahap validasi domain) dan ValidateType diatur ke FILE (menunjukkan metode validasi file).	www.example.com
RecordType	string	Jenis rekaman DNS yang perlu Anda tambahkan saat menggunakan metode validasi DNS untuk validasi domain. Nilai yang valid: TXT: text record. CNAME: alias record. Catatan Parameter ini hanya dikembalikan ketika Type diatur ke domain_verify (menunjukkan tahap validasi domain) dan ValidateType diatur ke DNS (menunjukkan metode validasi DNS).	TXT
CertId	string	ID sertifikat. Catatan Parameter ini dikembalikan saat sertifikat diterbitkan.	111111
RequestId	string	ID permintaan.	082FAB35-6AB9-4FD5-8750-D36673548E76
RecordDomain	string	Catatan host yang perlu Anda kelola saat menggunakan metode validasi DNS untuk validasi domain. Catatan Parameter ini hanya dikembalikan ketika Type diatur ke domain_verify (menunjukkan tahap validasi domain) dan ValidateType diatur ke DNS (menunjukkan metode validasi DNS).	_dnsauth
PrivateKey	string	Konten kunci privat sertifikat (dalam format PEM). Untuk informasi lebih lanjut tentang format PEM dan cara mengonversi format sertifikat, lihat Apa saja format sertifikat digital utama?. Catatan Parameter ini hanya dikembalikan ketika Type diatur ke certificate (menunjukkan bahwa sertifikat telah diterbitkan).	-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----
ValidateType	string	Metode validasi domain yang dipilih saat mengirimkan permintaan sertifikat. Nilai yang valid: DNS: validasi DNS. Metode ini memvalidasi kepemilikan domain dengan menambahkan rekaman DNS tertentu ke domain di platform manajemen DNS. FILE: validasi file. Metode ini memvalidasi kepemilikan domain dengan membuat file tertentu di server domain. Catatan Parameter ini hanya dikembalikan ketika Type diatur ke domain_verify (menunjukkan tahap validasi domain).	FILE
RecordValue	string	Nilai rekaman yang perlu Anda tambahkan saat menggunakan metode validasi DNS untuk validasi domain. Catatan Parameter ini hanya dikembalikan ketika Type diatur ke domain_verify (menunjukkan tahap validasi domain) dan ValidateType diatur ke DNS (menunjukkan metode validasi DNS).	20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy
Content	string	Konten yang perlu Anda tulis ke file yang baru dibuat saat menggunakan metode validasi file untuk validasi domain. Catatan Parameter ini hanya dikembalikan ketika Type diatur ke domain_verify (menunjukkan tahap validasi domain) dan ValidateType diatur ke FILE (menunjukkan metode validasi file).	http://example.com/.well-known/pki-validation/fileauth.txt
Uri	string	File yang perlu Anda buat di server domain saat menggunakan metode validasi file untuk validasi domain. Uri mencakup path dan nama file. Catatan Parameter ini hanya dikembalikan ketika Type diatur ke domain_verify (menunjukkan tahap validasi domain) dan ValidateType diatur ke FILE (menunjukkan metode validasi file).	/.well-known/pki-validation/fileauth.txt
Certificate	string	Konten sertifikat (dalam format PEM). Untuk informasi lebih lanjut tentang format PEM dan cara mengonversi format sertifikat, lihat Apa saja format sertifikat digital utama?. Catatan Parameter ini hanya dikembalikan ketika Type diatur ke certificate (menunjukkan bahwa sertifikat telah diterbitkan).	-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----

Contoh

Respons sukses

JSONformat

{
  "Type": "domain_verify",
  "Domain": "www.example.com",
  "RecordType": "TXT",
  "CertId": "111111",
  "RequestId": "082FAB35-6AB9-4FD5-8750-D36673548E76",
  "RecordDomain": "_dnsauth",
  "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----",
  "ValidateType": "FILE",
  "RecordValue": "20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy",
  "Content": "http://example.com/.well-known/pki-validation/fileauth.txt",
  "Uri": "/.well-known/pki-validation/fileauth.txt",
  "Certificate": "-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.